public interface CredentialEntrySearch extends OsidSearch
The search interface for governing credential entry searches.
Modifier and Type | Method and Description |
---|---|
CredentialEntrySearchRecord |
getCredentialEntrySearchRecord(Type credentialEntrySearchRecordType)
Gets the credential entry search record corresponding to the given
credential entry search record
Type. |
void |
orderCredentialEntryResults(CredentialEntrySearchOrder credentialEntrySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCredentialEntries(IdList credentialEntryIds)
Execute this search among the given list of credential entries.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCredentialEntries(IdList credentialEntryIds)
credentialEntryIds
- list of credential entry Ids
NullArgumentException
- credentialEntryIds
is null
mandatory
- This method must be implemented. void orderCredentialEntryResults(CredentialEntrySearchOrder credentialEntrySearchOrder)
credentialEntrySearchOrder
- credential entry search orderNullArgumentException
-
credentialEntrySearchOrder
is null
UnsupportedException
-
credentialEntrySearchOrder
is not of this servicemandatory
- This method must be implemented. CredentialEntrySearchRecord getCredentialEntrySearchRecord(Type credentialEntrySearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.credentialEntrySearchRecordType
- a credential entry search
record typeNullArgumentException
-
credentialEntrySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialEntrySearchRecordType)
is
false
mandatory
- This method must be implemented.