OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.StateSearchSession
Implementsosid.process.StateQuerySession
Description

This session provides methods for searching among State objects. The search query is constructed using the StateQuery.

getStatesByQuery() is the basic search method and returns a list of States. A more advanced search may be performed with getStatesBySearch(). It accepts an StateSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getStatesBySearch() returns an StateSearchResults that can be used to access the resulting StateList or be used to perform a search within the result set through StateList.

This session defines views that offer differing behaviors for searching.

  • federated process view: searches include states in processes of which this process is a ancestor in the process hierarchy
  • isolated process view: searches are restricted to states in this process

States may have a query record indicated by their respective record types. The query record is accessed via the StateQuery.

MethodgetStateSearch
Description

Gets a state search.

Returnosid.process.StateSearchthe state search
CompliancemandatoryThis method must be implemented.
MethodgetStateSearchOrder
Description

Gets a state search order. The StateSearchOrder is supplied to a StateSearch to specify the ordering of results.

Returnosid.process.StateSearchOrderthe state search order
CompliancemandatoryThis method must be implemented.
MethodgetStatesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.process.StateQuerystateQuerythe state query
osid.process.StateSearchstateSearchthe state search
Returnosid.process.StateSearchResultsthe state search results
ErrorsNULL_ARGUMENT stateQuery or stateSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stateQuery or stateSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStateQueryFromInspector
Description

Gets a state query from an inspector. The inspector is available from a StateSearchResults.

Parametersosid.process.StateQueryInspectorstateQueryInspectora state inspector
Returnosid.process.StateQuerythe state query
ErrorsNULL_ARGUMENT stateQueryInspector is null
UNSUPPORTED stateQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.