Interface ProcessSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProcessSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProcessList	getProcesses()	Gets the process list resulting from the search.
ProcessQueryInspector	getProcessQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProcessSearchResultsRecord	getProcessSearchResultsRecord(Type processSearchRecordType)	Gets the process search results record corresponding to the given process search record Type .This method is 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

getProcesses

ProcessList getProcesses()

Gets the process list resulting from the search.

Returns:

the process list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProcessQueryInspector

ProcessQueryInspector getProcessQueryInspector()

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

Returns:

the process query inspector

Compliance:

mandatory - This method must be implemented.

getProcessSearchResultsRecord

ProcessSearchResultsRecord getProcessSearchResultsRecord(Type processSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

processSearchRecordType - a process search record type

Returns:

the process search results record

Throws:

NullArgumentException - processSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.