org.osid.calendaring

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.