Interface OfferingConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OfferingConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
OfferingConstrainerQueryInspector	getOfferingConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
OfferingConstrainerList	getOfferingConstrainers()	Gets the OfferingConstrainerList resulting from a search.
OfferingConstrainerSearchResultsRecord	getOfferingConstrainerSearchResultsRecord(Type offeringConstrainerSearchRecordType)	Gets the offering constrainer search results record corresponding to the given offering constrainer 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

getOfferingConstrainers

OfferingConstrainerList getOfferingConstrainers()

Gets the OfferingConstrainerList resulting from a search.

Returns:

the offering constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerQueryInspector

OfferingConstrainerQueryInspector getOfferingConstrainerQueryInspector()

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

Returns:

the offering constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerSearchResultsRecord

OfferingConstrainerSearchResultsRecord getOfferingConstrainerSearchResultsRecord(Type offeringConstrainerSearchRecordType)
                                                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

offeringConstrainerSearchRecordType - an offering constrainer search record type

Returns:

the offering constrainer search results record

Throws:

NullArgumentException - offeringConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(offeringConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.