Interface DispatchConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DispatchConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DispatchConstrainerQueryInspector	getDispatchConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
DispatchConstrainerList	getDispatchConstrainers()	Gets the dispatch constrainer list resulting from a search.
DispatchConstrainerSearchResultsRecord	getDispatchConstrainerSearchResultsRecord(Type dispatchConstrainerSearchRecordType)	Gets the dispatch constrainer search results record corresponding to the given dispatch 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

getDispatchConstrainers

DispatchConstrainerList getDispatchConstrainers()

Gets the dispatch constrainer list resulting from a search.

Returns:

the dispatch constrainer list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getDispatchConstrainerQueryInspector

DispatchConstrainerQueryInspector getDispatchConstrainerQueryInspector()

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

Returns:

the dispatch constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getDispatchConstrainerSearchResultsRecord

DispatchConstrainerSearchResultsRecord getDispatchConstrainerSearchResultsRecord(Type dispatchConstrainerSearchRecordType)
                                                                          throws OperationFailedException

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

Parameters:

dispatchConstrainerSearchRecordType - a dispatch constrainer search record type

Returns:

the dispatch constrainer search results record

Throws:

NullArgumentException - dispatchConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.