Interface ProcessEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProcessEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProcessEnablerQueryInspector	getProcessEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProcessEnablerList	getProcessEnablers()	Gets the ProcessEnablerList resulting from a search.
ProcessEnablerSearchResultsRecord	getProcessEnablerSearchResultsRecord(Type processEnablerSearchRecordType)	Gets the process enabler search results record corresponding to the given process enabler 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

getProcessEnablers

ProcessEnablerList getProcessEnablers()

Gets the ProcessEnablerList resulting from a search.

Returns:

the process enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProcessEnablerQueryInspector

ProcessEnablerQueryInspector getProcessEnablerQueryInspector()

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

Returns:

the process enabler query inspector

Compliance:

mandatory - This method must be implemented.

getProcessEnablerSearchResultsRecord

ProcessEnablerSearchResultsRecord getProcessEnablerSearchResultsRecord(Type processEnablerSearchRecordType)
                                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

processEnablerSearchRecordType - a process enabler search record type

Returns:

the process enabler search results record

Throws:

NullArgumentException - processEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(processEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.