public interface DeedSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
BuildingSearchOrder |
getBuildingSearchOrder()
Gets the building search order.
|
DeedSearchOrderRecord |
getDeedSearchOrderRecord(Type deedRecordType)
Gets the deed search order record corresponding to the given deed
record Type.
|
ResourceSearchOrder |
getOwnerSearchOrder()
Gets the owner resource search order.
|
void |
orderByBuilding(SearchOrderStyle style)
Specifies a preference for ordering the result set by the building.
|
void |
orderByOwner(SearchOrderStyle style)
Specifies a preference for ordering the result set by the owner.
|
boolean |
supportsBuildingSearchOrder()
Tests if a building search order is available.
|
boolean |
supportsOwnerSearchOrder()
Tests if an owner resource search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByBuilding(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBuildingSearchOrder()
true
if a building search order is available,
false
otherwisemandatory
- This method must be implemented. BuildingSearchOrder getBuildingSearchOrder()
UnimplementedException
-
supportsBuildingSearchOrder()
is false
optional
- This method must be implemented if
supportsBuildingSearchOrder()
is true.
void orderByOwner(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsOwnerSearchOrder()
true
if an owner search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getOwnerSearchOrder()
UnimplementedException
-
supportsOwnerSearchOrder()
is false
optional
- This method must be implemented if
supportsOwnerSearchOrder()
is true.
DeedSearchOrderRecord getDeedSearchOrderRecord(Type deedRecordType) throws OperationFailedException
deedRecordType
- a deed record typeNullArgumentException
- deedRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(deedRecordType)
is false
mandatory
- This method must be implemented.