OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueSearchSession
Implementsosid.hold.IssueQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetIssueSearch
Description

Gets an issue search.

Returnosid.hold.IssueSearchthe issue search
CompliancemandatoryThis method must be implemented.
MethodgetIssueSearchOrder
Description

Gets an issue search order. The IssueSearchOrder is supplied to an IssueSearch to specify the ordering of results.

Returnosid.hold.IssueSearchOrderthe issue search order
CompliancemandatoryThis method must be implemented.
MethodgetIssuesBySearch
Description

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

Parametersosid.hold.IssueQueryissueQuerythe issue query
osid.hold.IssueSearchissueSearchthe issue search
Returnosid.hold.IssueSearchResultsthe issue search results
ErrorsNULL_ARGUMENT issueQuery or issueSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED issueQuery or issueSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetIssueQueryFromInspector
Description

Gets an issue query. from an inspector. The inspector is available from an IssueSearchResults.

Parametersosid.hold.IssueQueryInspectorissueQueryInspectoran issue query inspector
Returnosid.hold.IssueQuerythe issue query
ErrorsNULL_ARGUMENT issueQueryInspector is null
UNSUPPORTED issueQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.