public interface PersonSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderBySalutation(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByGivenName(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByPreferredName(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySurname(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByGenerationQualifier(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByQualificationSuffix(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByBirthDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDeathDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByInstitutionalIdentifier(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. PersonSearchOrderRecord getPersonSearchOrderRecord(Type personRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.personRecordType
- a person record typeNullArgumentException
- personRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(personRecordType)
is false
mandatory
- This method must be implemented.