Interface CredentialEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CredentialEntrySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CredentialEntryList	getCredentialEntries()	Gets the course list resulting from a search.
CredentialEntryQueryInspector	getCredentialEntryQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CredentialEntrySearchResultsRecord	getCredentialEntrySearchResultsRecord(Type credentialEntrySearchRecordType)	Gets the credential entry search results record corresponding to the given credential entry search record Type.

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

getCredentialEntries

CredentialEntryList getCredentialEntries()

Gets the course list resulting from a search.

Returns:

the credential entry list

Throws:

IllegalStateException - the credential entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCredentialEntryQueryInspector

CredentialEntryQueryInspector getCredentialEntryQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCredentialEntrySearchResultsRecord

CredentialEntrySearchResultsRecord getCredentialEntrySearchResultsRecord(Type credentialEntrySearchRecordType)
                                                                  throws OperationFailedException

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

Throws:

NullArgumentException - credentialEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.