OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.ActionEnablerSearchSession
Implementsosid.control.rules.ActionEnablerQuerySession
Description

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

getActionEnablersByQuery() is the basic search method and returns a list of ActionEnablers. An more advanced search may be performed with getActionEnablersBySearch(). It accepts an ActionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as control. getActionEnablersBySearch() returns an ActionEnablerSearchResults that can be used to access the resulting ActionEnablerList or be used to perform a search within the result set through ActionEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated system view: searches include action enablers in systems of which this system is an ancestor in the system hierarchy
  • isolated system view: searches are restricted to action enablers in this system

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

MethodgetActionEnablerSearch
Description

Gets an action enabler search.

Returnosid.control.rules.ActionEnablerSearchthe action enabler search
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablerSearchOrder
Description

Gets an action enabler search order. The ActionEnablerSearchOrder is supplied to an ActionEnablerSearch to specify the ordering of results.

Returnosid.control.rules.ActionEnablerSearchOrderthe action enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablersBySearch
Description

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

Parametersosid.control.rules.ActionEnablerQueryactionEnablerQuerythe action enabler query
osid.control.rules.ActionEnablerSearchactionEnablerSearchthe action enabler search
Returnosid.control.rules.ActionEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT actionEnablerQuery or actionEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED actionEnablerQuery or actionEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablerQueryFromInspector
Description

Gets an action enabler query from an inspector. The inspector is available from an ActionEnablerSearchResults.

Parametersosid.control.rules.ActionEnablerQueryInspectoractionEnablerQueryInspectoran action enabler query inspector
Returnosid.control.rules.ActionEnablerQuerythe action enabler query
ErrorsNULL_ARGUMENT actionEnablerQueryInspector is null
UNSUPPORTED actionEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.