public interface AuthorizationSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AgentSearchOrder |
getAgentSearchOrder()
Gets the agent search order.
|
AuthorizationSearchOrderRecord |
getAuthorizationSearchOrderRecord(Type authorizationRecordType)
Gets the authorization search order record corresponding to the given
function record
Type. |
FunctionSearchOrder |
getFunctionSearchOrder()
Gets the function search order.
|
QualifierSearchOrder |
getQualifierSearchOrder()
Gets the qualifier search order.
|
ResourceSearchOrder |
getResourceSearchOrder()
Gets the resource search order.
|
void |
orderByAgent(SearchOrderStyle style)
Specifies a preference for ordering the result set by the agent.
|
void |
orderByFunction(SearchOrderStyle style)
Specifies a preference for ordering the result set by the active
status.
|
void |
orderByQualifier(SearchOrderStyle style)
Specifies a preference for ordering the result set by the qualifier,
|
void |
orderByResource(SearchOrderStyle style)
Specifies a preference for ordering the result set by the resource.
|
void |
orderByTrust(SearchOrderStyle style)
Specifies a preference for ordering the result set by the trust.
|
boolean |
supportsAgentSearchOrder()
Tests if an
Agent is available. |
boolean |
supportsFunctionSearchOrder()
Tests if a
Function is available. |
boolean |
supportsQualifierSearchOrder()
Tests if a
Qualifier is available. |
boolean |
supportsResourceSearchOrder()
Tests if a
Resource is available. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByResource(SearchOrderStyle style)
style
- the search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsResourceSearchOrder()
Resource
is available. true
if a resource search order interface is
available, false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
UnimplementedException
-
supportsResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsResourceSearchOrder()
is true.
void orderByTrust(SearchOrderStyle style)
style
- the search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByAgent(SearchOrderStyle style)
style
- the search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAgentSearchOrder()
Agent
is available. true
if an agent search order interface is
available, false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getAgentSearchOrder()
UnimplementedException
-
supportsAgentSearchOrder()
is false
optional
- This method must be implemented if
supportsAgentSearchOrder()
is true.
void orderByFunction(SearchOrderStyle style)
style
- the search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsFunctionSearchOrder()
Function
is available. true
if a function search order interface is
available, false
otherwisemandatory
- This method must be implemented. FunctionSearchOrder getFunctionSearchOrder()
UnimplementedException
-
supportsFunctionSearchOrder()
is false
optional
- This method must be implemented if
supportsQualifierSearchOrder()
is true.
void orderByQualifier(SearchOrderStyle style)
style
- the search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsQualifierSearchOrder()
Qualifier
is available. true
if a qualifier search order interface is
available, false
otherwisemandatory
- This method must be implemented. QualifierSearchOrder getQualifierSearchOrder()
UnimplementedException
-
supportsQualifierSearchOrder()
is false
optional
- This method must be implemented if
supportsQualifierSearchOrder()
is true.
AuthorizationSearchOrderRecord getAuthorizationSearchOrderRecord(Type authorizationRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.authorizationRecordType
- an authorization record typeNullArgumentException
- authorizationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(authorizationRecordType)
is false
mandatory
- This method must be implemented.