Interface JobConstrainerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface JobConstrainerEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
JobConstrainerEnablerQueryInspector	getJobConstrainerEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
JobConstrainerEnablerList	getJobConstrainerEnablers()	Gets the JobConstrainerEnablerList resulting from a search.
JobConstrainerEnablerSearchResultsRecord	getJobConstrainerEnablerSearchResultsRecord(Type jobConstrainerEnablerSearchRecordType)	Gets the job constrainer enabler search results record corresponding to the given job constrainer enabler 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

getJobConstrainerEnablers

JobConstrainerEnablerList getJobConstrainerEnablers()

Gets the JobConstrainerEnablerList resulting from a search.

Returns:

the job constrainer enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablerQueryInspector

JobConstrainerEnablerQueryInspector getJobConstrainerEnablerQueryInspector()

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

Returns:

the job constrainer enabler query inspector

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablerSearchResultsRecord

JobConstrainerEnablerSearchResultsRecord getJobConstrainerEnablerSearchResultsRecord(Type jobConstrainerEnablerSearchRecordType)
                                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerSearchRecordType - a job constrainer enabler search record type

Returns:

the job constrainer enabler search results record

Throws:

NullArgumentException - jobConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(jobConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.