OSID Logo
OSID Specifications
hold rules package
Version 3.1.0
Interfaceosid.hold.rules.IssueConstrainerEnablerSearchSession
Implementsosid.hold.rules.IssueConstrainerEnablerQuerySession
Used Byosid.hold.rules.HoldRulesManager
osid.hold.rules.HoldRulesProxyManager
Description

This session provides methods for searching among IssueConstrainerEnablers. The search query is constructed using the IssueConstrainerEnablerQuery.

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

This session defines views that offer differing behaviors for searching.

  • federated oubliette view: searches include issue constrainer enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
  • isolated oubliette view: searches are restricted to issue constrainer enablers in this oubliette

Issue constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the IssueConstrainerEnablerQuery.

MethodgetIssueConstrainerEnablerSearch
Description

Gets an issue constrainer enabler search.

Returnosid.hold.rules.IssueConstrainerEnablerSearch the issue constrainer enabler search
Compliancemandatory This method must be implemented.
MethodgetIssueConstrainerEnablerSearchOrder
Description

Gets an issue constrainer enabler search order. The IssueConstrainerEnablerSearchOrder is supplied to an IssueConstrainerEnablerSearch to specify the ordering of results.

Returnosid.hold.rules.IssueConstrainerEnablerSearchOrder the issue constrainer enabler search order
Compliancemandatory This method must be implemented.
MethodgetIssueConstrainerEnablersBySearch
Description

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

Parametersosid.hold.rules.IssueEnablerQueryissueConstrainerEnablerQuery the issue constrainer enabler query
osid.hold.rules.IssueConstrainerEnablerSearchissueConstrainerEnablerSearch the issue constrainer enabler search
Returnosid.hold.rules.IssueConstrainerEnablerSearchResults the returned search results
ErrorsNULL_ARGUMENT issueConstrainerEnablerQuery or issueConstrainerEnablerSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED issueConstrainerEnablerQuery or issueConstrainerEnablerSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetIssueConstrainerEnablerQueryFromInspector
Description

Gets an issue constrainer enabler query from an inspector. The inspector is available from an IssueConstrainerEnablerSearchResults.

Parametersosid.hold.rules.IssueConstrainerEnablerQueryInspectorissueConstrainerEnablerQueryInspector an issue constrainer enabler query inspector
Returnosid.hold.rules.IssueConstrainerEnablerQuery the issue constrainer enabler query
ErrorsNULL_ARGUMENT issueConstrainerEnablerQueryInspector is null
UNSUPPORTED issueConstrainerEnablerQueryInspector is not of this service
Compliancemandatory This method must be implemented.