OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.RequestTransactionQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching requests. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchBrokerId
Description

Sets the broker Id for this query.

Parametersosid.id.IdbrokerIdthe broker Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT brokerId is null
CompliancemandatoryThis method must be implemented.
MethodclearBrokerIdTerms
Description

Clears the broker Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerQuery
Description

Tests if a BrokerQuery is available.

Returnboolean true if a broker query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBrokerQuery
Description

Gets the query for a broker. Multiple retrievals produce a nested OR term.

Returnosid.provisioning.BrokerQuerythe broker query
ErrorsUNIMPLEMENTED supportsBrokerQuery() is false
ComplianceoptionalThis method must be implemented if supportsBrokerQuery() is true.
MethodclearBrokerTerms
Description

Clears the broker query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubmitDate
Description

Matches transactions with a submit date in the given range inclusive.

Parametersosid.calendaring.DateTimefromthe range start
osid.calendaring.DateTimetothe range end
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodclearSubmitDateTerms
Description

Clears the submit date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubmitterId
Description

Sets the submitter Id for this query.

Parametersosid.id.IdresourceIdthe resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubmitterIdTerms
Description

Clears the submitter Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubmitterQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubmitterQuery
Description

Gets the query for a submitter. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsSubmitterQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubmitterQuery() is true.
MethodclearSubmitterTerms
Description

Clears the submitter query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubmittingAgentId
Description

Sets the submitting agent Id for this query.

Parametersosid.id.IdagentIdthe agent Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubmittingAgentIdTerms
Description

Clears the submitting agent Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubmittingAgentQuery
Description

Tests if an AgentQuery is available.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubmittingAgentQuery
Description

Gets the query for a submitting agent. Multiple retrievals produce a nested OR term.

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsSubmittingAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubmittingAgentQuery() is true.
MethodclearSubmittingAgentTerms
Description

Clears the submitting agent query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRequestId
Description

Sets the request Id for this query.

Parametersosid.id.IdrequestIdthe request Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT requestId is null
CompliancemandatoryThis method must be implemented.
MethodclearRequestIdTerms
Description

Clears the request Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRequestQuery
Description

Tests if a RequestQuery is available.

Returnboolean true if a request query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRequestQuery
Description

Gets the query for a request. Multiple retrievals produce a nested OR term.

Returnosid.provisioning.RequestQuerythe request query
ErrorsUNIMPLEMENTED supportsRequestQuery() is false
ComplianceoptionalThis method must be implemented if supportsRequestQuery() is true.
MethodmatchAnyRequest
Description

Matches transactions with any request.

Parametersbooleanmatch true for to match transactions with any request, match, false to match transaction with no requests
CompliancemandatoryThis method must be implemented.
MethodclearRequestTerms
Description

Clears the request query terms.

CompliancemandatoryThis method must be implemented.
MethodgetRequestTransactionQueryRecord
Description

Gets the request transaction query record corresponding to the given Requesttrsnaction record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperequesttransactionRecordTypea request transaction record type
Returnosid.provisioning.records.RequestTransactionQueryRecordthe request transaction query record
ErrorsNULL_ARGUMENT requestTransactionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requestTransactionRecordType) is false
CompliancemandatoryThis method must be implemented.