public interface AuthorizationSearch extends OsidSearch
AuthorizationSearch
defines the interface for specifying
authorization search options.
Modifier and Type | Method and Description |
---|---|
AuthorizationSearchRecord |
getAuthorizationSearchRecord(Type authorizationSearchRecordType)
Gets the authorization search record corresponding to the given
authorization search record
Type. |
void |
orderAuthorizationResults(AuthorizationSearchOrder authorizationSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAuthorizations(IdList authorizationIds)
Execute this search among the given list of authorizations.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAuthorizations(IdList authorizationIds)
authorizationIds
- list of authorizationsNullArgumentException
- authorizationIds
is null
mandatory
- This method must be implemented. void orderAuthorizationResults(AuthorizationSearchOrder authorizationSearchOrder)
authorizationSearchOrder
- authorization search orderNullArgumentException
- authorizationSearchOrder
is null
UnsupportedException
- authorizationSearchOrder
is not of this servicemandatory
- This method must be implemented. AuthorizationSearchRecord getAuthorizationSearchRecord(Type authorizationSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.authorizationSearchRecordType
- an authorization search record
typeNullArgumentException
-
authorizationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(authorizationSearchRecordType)
is
false
mandatory
- This method must be implemented.