public interface ContactSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ResourceSearchOrder |
getAddresseeSearchOrder()
Gets the resource order.
|
AddressSearchOrder |
getAddressSearchOrder()
Gets the address order.
|
ContactSearchOrderRecord |
getContactSearchOrderRecord(Type contactRecordType)
Gets the contact search order record corresponding to the given
contact record
Type. |
void |
orderByAddress(SearchOrderStyle style)
Specifies a preference for ordering the result set by the address.
|
void |
orderByAddressee(SearchOrderStyle style)
Specifies a preference for ordering the result set by the resource.
|
void |
orderByReference(SearchOrderStyle style)
Specifies a preference for ordering the result set by the reference.
|
boolean |
supportsAddresseeSearchOrder()
Tests if a resource order is available.
|
boolean |
supportsAddressSearchOrder()
Tests if an address order interface is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByReference(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByAddressee(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAddresseeSearchOrder()
true
if a resource order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getAddresseeSearchOrder()
UnimplementedException
-
supportsAddresseeSearchOrder()
is false
optional
- This method must be implemented if
supportsAddresseeSearchOrder()
is true.
void orderByAddress(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAddressSearchOrder()
true
if an address order is available,
false
otherwisemandatory
- This method must be implemented. AddressSearchOrder getAddressSearchOrder()
UnimplementedException
-
supportsAddressSearchOrder()
is false
optional
- This method must be implemented if
supportsAddressSearchOrder()
is true.
ContactSearchOrderRecord getContactSearchOrderRecord(Type contactRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.contactRecordType
- a contact record typeNullArgumentException
- contactRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(contactRecordType)
is false
mandatory
- This method must be implemented.