Interface CommitmentEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CommitmentEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CommitmentEnablerQueryInspector	getCommitmentEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CommitmentEnablerList	getCommitmentEnablers()	Gets the CommitmentEnablerList resulting from a search.
CommitmentEnablerSearchResultsRecord	getCommitmentEnablerSearchResultsRecord(Type commitmentEnablerSearchRecordType)	Gets the commitment enabler search results record corresponding to the given commitment enabler 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

getCommitmentEnablers

CommitmentEnablerList getCommitmentEnablers()

Gets the CommitmentEnablerList resulting from a search.

Returns:

the commitment enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablerQueryInspector

CommitmentEnablerQueryInspector getCommitmentEnablerQueryInspector()

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

Returns:

the commitment enabler query inspector

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablerSearchResultsRecord

CommitmentEnablerSearchResultsRecord getCommitmentEnablerSearchResultsRecord(Type commitmentEnablerSearchRecordType)
                                                                      throws OperationFailedException,
PermissionDeniedException

Gets the commitment enabler search results record corresponding to the given commitment enabler search record Type . This method must be used to retrieve an object implementing the requested record.

Parameters:

commitmentEnablerSearchRecordType - a commitment enabler search record type

Returns:

the commitment enabler search results record

Throws:

NullArgumentException - commitmentEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(commitmentEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.