Interface ProcessConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProcessConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProcessConstrainerQueryInspector	getProcessConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProcessConstrainerList	getProcessConstrainers()	Gets the process constrainer list resulting from a search.
ProcessConstrainerSearchResultsRecord	getProcessConstrainerSearchResultsRecord(Type processConstrainerSearchRecordType)	Gets the process constrainer search results record corresponding to the given process 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

getProcessConstrainers

ProcessConstrainerList getProcessConstrainers()

Gets the process constrainer list resulting from a search.

Returns:

the process constrainer list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProcessConstrainerQueryInspector

ProcessConstrainerQueryInspector getProcessConstrainerQueryInspector()

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

Returns:

the process constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getProcessConstrainerSearchResultsRecord

ProcessConstrainerSearchResultsRecord getProcessConstrainerSearchResultsRecord(Type processConstrainerSearchRecordType)
                                                                        throws OperationFailedException

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

Parameters:

processConstrainerSearchRecordType - a process constrainer search record type

Returns:

the process constrainer search results record

Throws:

NullArgumentException - processConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.