OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.RequestTransactionSearchSession
Implementsosid.provisioning.RequestTransactionQuerySession
Used Byosid.provisioning.ProvisioningManager
osid.provisioning.ProvisioningProxyManager
Description

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

getRequestTransactionsByQuery() is the basic search method and returns a list of RequestTransactions. A more advanced search may be performed with getRequestTransactionsBySearch(). It accepts a RequestTransactionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRequestTransactionsBySearch() returns a RequestTransactionSearchResults that can be used to access the resulting RequestTransactionList or be used to perform a search within the result set through RequestTransactionSearch.
MethodgetRequestTransactionSearch
Description

Gets a request transaction search.

Returnosid.provisioning.RequestTransactionSearch the request transaction search
Compliancemandatory This method must be implemented.
MethodgetRequestTransactionSearchOrder
Description

Gets a request transaction search order. The RequestTransactionSearchOrder is supplied to a RequestTransactionSearch to specify the ordering of results.

Returnosid.provisioning.RequestTransactionSearchOrder the request transaction search order
Compliancemandatory This method must be implemented.
MethodgetRequestTransactionsBySearch
Description

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

Parametersosid.provisioning.RequestTransactionQueryrequestTransactionQuery the request transaction query
osid.provisioning.RequestTransactionSearchrequestTransactionSearch the request transaction search
Returnosid.provisioning.RequestTransactionSearchResults the request transaction search results
ErrorsNULL_ARGUMENT requestTransactionQuery or requestTransactionSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED requestTransactionQuery or requestTransactionSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetRequestTransactionQueryFromInspector
Description

Gets a request transaction query from an inspector. The inspector is available from a RequestTransactionSearchResults.

Parametersosid.provisioning.RequestTransactionQueryInspectorrequestTransactionQueryInspector a request transaction query inspector
Returnosid.provisioning.RequestTransactionQuery the request transaction query
ErrorsNULL_ARGUMENT requestTransactionQueryInspector is null
UNSUPPORTED requestTransactionQueryInspector is not of this service
Compliancemandatory This method must be implemented.