Interface CredentialSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CredentialSearch
extends OsidSearch

The search interface for governing credential searches.

Method Summary

Modifier and Type	Method	Description
CredentialSearchRecord	getCredentialSearchRecord(Type credentialSearchRecordType)	Gets the credential search record corresponding to the given credential search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCredentialResults(CredentialSearchOrder credentialSearchOrder)	Specify an ordering to the search results.
void	searchAmongCredentials(IdList credentialIds)	Execute this search among the given list of credentials.

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

searchAmongCredentials

void searchAmongCredentials(IdList credentialIds)

Execute this search among the given list of credentials.

Parameters:

credentialIds - list of credentials

Throws:

NullArgumentException - credentialIds is null

Compliance:

mandatory - This method must be implemented.

orderCredentialResults

void orderCredentialResults(CredentialSearchOrder credentialSearchOrder)

Specify an ordering to the search results.

Parameters:

credentialSearchOrder - credential search order

Throws:

NullArgumentException - credentialSearchOrder is null

UnsupportedException - credentialSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCredentialSearchRecord

CredentialSearchRecord getCredentialSearchRecord(Type credentialSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

credentialSearchRecordType - a credential search record type

Returns:

the credential search record

Throws:

NullArgumentException - credentialSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.