Interface CredentialSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CredentialSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
CredentialQueryInspector	getCredentialQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CredentialList	getCredentials()	Gets the credential list resulting from a search.
CredentialSearchResultsRecord	getCredentialSearchResultsRecord(Type credentialSearchRecordType)	Gets the credential search results record corresponding to the given credential search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getCredentials

CredentialList getCredentials()

Gets the credential list resulting from a search.

Returns:

the credential list

Throws:

IllegalStateException - the credential list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCredentialQueryInspector

CredentialQueryInspector getCredentialQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the credential query inspector

Compliance:

mandatory - This method must be implemented.

getCredentialSearchResultsRecord

CredentialSearchResultsRecord getCredentialSearchResultsRecord(Type credentialSearchRecordType)
                                                        throws OperationFailedException

Gets the credential search results 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 results record

Throws:

NullArgumentException - credentialSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.