public interface CredentialSearch extends OsidSearch
The search interface for governing credential searches.
Modifier and Type | Method and Description |
---|---|
CredentialSearchRecord |
getCredentialSearchRecord(Type credentialSearchRecordType)
Gets the credential search record corresponding to the given
credential search record
Type. |
void |
orderCredentialResults(CredentialSearchOrder credentialSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCredentials(IdList credentialIds)
Execute this search among the given list of credentials.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCredentials(IdList credentialIds)
credentialIds
- list of credentialsNullArgumentException
- credentialIds
is
null
mandatory
- This method must be implemented. void orderCredentialResults(CredentialSearchOrder credentialSearchOrder)
credentialSearchOrder
- credential search orderNullArgumentException
- credentialSearchOrder
is null
UnsupportedException
- credentialSearchOrder
is not of this servicemandatory
- This method must be implemented. CredentialSearchRecord getCredentialSearchRecord(Type credentialSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.credentialSearchRecordType
- a credential search record typeNullArgumentException
-
credentialSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialSearchRecordType)
is
false
mandatory
- This method must be implemented.