OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.RequestTransactionSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByBroker
Description

Orders the results by the broker.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerSearchOrder
Description

Tests if a broker search order is available.

Returnboolean true if a broker search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBrokerSearchOrder
Description

Gets the broker search order.

Returnosid.provisioning.BrokerSearchOrderthe broker search order
ErrorsILLEGAL_STATE supportsBrokerSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderBySubmitDate
Description

Orders the results by the submit date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderBySubmitter
Description

Orders the results by the submitter.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsSubmitterSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubmitterSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsSubmitterSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderBySubmittingAgent
Description

Orders the results by submitting agent.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsSubmittingAgentSearchOrder
Description

Tests if an agent search order is available.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubmittingAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsILLEGAL_STATE supportsSubmittingAgentSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetRequestTransactionSearchOrderRecord
Description

Gets the request transaction search order record corresponding to the given request record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TyperequestTransactionRecordTypea request transaction record type
Returnosid.provisioning.records.RequestTransactionSearchOrderRecordthe request transaction search order record
ErrorsNULL_ARGUMENT requestTransactionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requestTransactionRecordType) is false
CompliancemandatoryThis method must be implemented.