public interface DirectoryEntrySearchOrder extends OsidObjectSearchOrder
An interface for specifying the order of search results.
Modifier and Type | Method and Description |
---|---|
AgentSearchOrder |
getOwnerSearchOrder()
Gets an agent search order interface.
|
void |
orderByCreatedTime(SearchOrderStyle style)
Specifies a preference for ordering the result set by the entry
creation time.
|
void |
orderByLastAccessTime(SearchOrderStyle style)
Specifies a preference for ordering the result set by the entry last
access time.
|
void |
orderByModifiedTime(SearchOrderStyle style)
Specifies a preference for ordering the result set by the entry
modification time.
|
void |
orderByName(SearchOrderStyle style)
Specifies a preference for ordering the result set by the entry name.
|
void |
orderByOwner(SearchOrderStyle style)
Specifies a preference for ordering the result set by the entry owner.
|
void |
orderByPath(SearchOrderStyle style)
Specifies a preference for ordering the result set by the entry path.
|
boolean |
supportsOwnerSearchOrder()
Tests if an agent search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByName(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByPath(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOwner(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsOwnerSearchOrder()
true
if an agent search order interface is
available, false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getOwnerSearchOrder()
UnimplementedException
-
supportsOwnerSearchOrder()
is false
optional
- This method must be implemented if
supportsOwnerSearchOrder()
is true.
void orderByCreatedTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByModifiedTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByLastAccessTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented.