Interface JobConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface JobConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
JobConstrainerQueryInspector	getJobConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
JobConstrainerList	getJobConstrainers()	Gets the JobConstrainerList resulting from a search.
JobConstrainerSearchResultsRecord	getJobConstrainerSearchResultsRecord(Type jobConstrainerSearchRecordType)	Gets the job constrainer search results record corresponding to the given job constrainer search record Type .This method must be 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

getJobConstrainers

JobConstrainerList getJobConstrainers()

Gets the JobConstrainerList resulting from a search.

Returns:

the job constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getJobConstrainerQueryInspector

JobConstrainerQueryInspector getJobConstrainerQueryInspector()

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

Returns:

the job constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getJobConstrainerSearchResultsRecord

JobConstrainerSearchResultsRecord getJobConstrainerSearchResultsRecord(Type jobConstrainerSearchRecordType)
                                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerSearchRecordType - a job constrainer search record type

Returns:

the job constrainer search results record

Throws:

NullArgumentException - jobConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(jobConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.