org.osid.workflow

Interface WorkSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface WorkSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
WorkQueryInspector	getWorkQueryInspector() Gets the inspector for the query to examine the terms used in the search.
WorkList	getWorks() Gets the work list resulting from a search.
WorkSearchResultsRecord	getWorkSearchResultsRecord(Type workSearchRecordType) Gets the work search results record corresponding to the given work search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getWorks

WorkList getWorks()

Gets the work list resulting from a search.

Returns:

the work list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getWorkQueryInspector

WorkQueryInspector getWorkQueryInspector()

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

Returns:

the work query inspector

Compliance:

mandatory - This method must be implemented.

getWorkSearchResultsRecord

WorkSearchResultsRecord getWorkSearchResultsRecord(Type workSearchRecordType)
                                                   throws OperationFailedException

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

Parameters:

workSearchRecordType - a work search record type

Returns:

the work search results record

Throws:

NullArgumentException - workSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.