Interface CredentialEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CredentialEntrySearch
extends OsidSearch

The search interface for governing credential entry searches.

Method Summary

Modifier and Type	Method	Description
CredentialEntrySearchRecord	getCredentialEntrySearchRecord(Type credentialEntrySearchRecordType)	Gets the credential entry search record corresponding to the given credential entry search record Type .This method is used to retrieve an object implementing the requested record.
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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongCredentialEntries

void searchAmongCredentialEntries(IdList credentialEntryIds)

Execute this search among the given list of credential entries.

Parameters:

credentialEntryIds - list of credential entry Ids

Throws:

NullArgumentException - credentialEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderCredentialEntryResults

void orderCredentialEntryResults(CredentialEntrySearchOrder credentialEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

credentialEntrySearchOrder - credential entry search order

Throws:

NullArgumentException - credentialEntrySearchOrder is null

UnsupportedException - credentialEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCredentialEntrySearchRecord

CredentialEntrySearchRecord getCredentialEntrySearchRecord(Type credentialEntrySearchRecordType)
                                                    throws OperationFailedException

Gets the credential entry search record corresponding to the given credential entry search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

credentialEntrySearchRecordType - a credential entry search record type

Returns:

the credential entry search record

Throws:

NullArgumentException - credentialEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.