org.osid.personnel

Interface PersonSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface PersonSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
PersonSearchOrderRecord	getPersonSearchOrderRecord(Type personRecordType) Gets the person search order record corresponding to the given person record Type.
void	orderByBirthDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the birth date.
void	orderByDeathDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the death date.
void	orderByGenerationQualifier(SearchOrderStyle style) Specifies a preference for ordering the result set by the generation qualifier.
void	orderByGivenName(SearchOrderStyle style) Specifies a preference for ordering the result set by the given name.
void	orderByInstitutionalIdentifier(SearchOrderStyle style) Specifies a preference for ordering the result set by the institutional identifier.
void	orderByPreferredName(SearchOrderStyle style) Specifies a preference for ordering the result set by the preferred name.
void	orderByQualificationSuffix(SearchOrderStyle style) Specifies a preference for ordering the result set by the qualification suffix.
void	orderBySalutation(SearchOrderStyle style) Specifies a preference for ordering the result set by the salutation.
void	orderBySurname(SearchOrderStyle style) Specifies a preference for ordering the result set by the surname.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

orderBySalutation

void orderBySalutation(SearchOrderStyle style)

Specifies a preference for ordering the result set by the salutation.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByGivenName

void orderByGivenName(SearchOrderStyle style)

Specifies a preference for ordering the result set by the given name.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByPreferredName

void orderByPreferredName(SearchOrderStyle style)

Specifies a preference for ordering the result set by the preferred name.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySurname

void orderBySurname(SearchOrderStyle style)

Specifies a preference for ordering the result set by the surname.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByGenerationQualifier

void orderByGenerationQualifier(SearchOrderStyle style)

Specifies a preference for ordering the result set by the generation qualifier.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByQualificationSuffix

void orderByQualificationSuffix(SearchOrderStyle style)

Specifies a preference for ordering the result set by the qualification suffix.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByBirthDate

void orderByBirthDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the birth date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDeathDate

void orderByDeathDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the death date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByInstitutionalIdentifier

void orderByInstitutionalIdentifier(SearchOrderStyle style)

Specifies a preference for ordering the result set by the institutional identifier.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getPersonSearchOrderRecord

PersonSearchOrderRecord getPersonSearchOrderRecord(Type personRecordType)
                                                   throws OperationFailedException

Gets the person search order record corresponding to the given person record Type. Multiple retrievals return the same underlying object.

Parameters:

personRecordType - a person record type

Returns:

the person search order record

Throws:

NullArgumentException - personRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(personRecordType) is false

Compliance:

mandatory - This method must be implemented.