Interface CommitmentSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CommitmentSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CommitmentQueryInspector	getCommitmentQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CommitmentList	getCommitments()	Gets the commitment list resulting from the search.
CommitmentSearchResultsRecord	getCommitmentSearchResultsRecord(Type commitmentSearchRecordType)	Gets the commitment search results record corresponding to the given commitment 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

getCommitments

CommitmentList getCommitments()

Gets the commitment list resulting from the search.

Returns:

the commitment list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCommitmentQueryInspector

CommitmentQueryInspector getCommitmentQueryInspector()

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.

getCommitmentSearchResultsRecord

CommitmentSearchResultsRecord getCommitmentSearchResultsRecord(Type commitmentSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

commitmentSearchRecordType - a commitment search record type

Returns:

the commitment search results record

Throws:

NullArgumentException - commitmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.