public interface CanonicalUnitSearchOrder extends OsidObjectSearchOrder, OsidOperableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitSearchOrderRecord |
getCanonicalUnitSearchOrderRecord(Type canonicalUnitRecordType)
Gets the canonical unit search order record corresponding to the given
canonical unit record
Type. |
void |
orderByCode(SearchOrderStyle style)
Specifies a preference for ordering the result set by the code.
|
void |
orderByTitle(SearchOrderStyle style)
Specifies a preference for ordering the result set by the title.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByTitle(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCode(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. CanonicalUnitSearchOrderRecord getCanonicalUnitSearchOrderRecord(Type canonicalUnitRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.canonicalUnitRecordType
- a canonical unit record typeNullArgumentException
- canonicalUnitRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitRecordType)
is false
mandatory
- This method must be implemented.