OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.RequestTransaction
Implementsosid.OsidRelationship
Description

A RequestTransaction is set of Requests.

MethodgetBrokerId
Description

Gets the Id of the broker.

Returnosid.id.Idthe broker Id
CompliancemandatoryThis method must be implemented.
MethodgetBroker
Description

Gets the broker.

Returnosid.provisioning.Brokerthe broker
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSubmitDate
Description

Gets the date this transaction was submitted. The submitted date may differ from the effective dates of this provision.

Returnosid.calendaring.DateTimethe transaction submit date
CompliancemandatoryThis method must be implemented.
MethodgetSubmitterId
Description

Gets the Id of the submitter.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetSubmitter
Description

Gets the submitter.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSubmittingAgentId
Description

Gets the Id of the submitting agent.

Returnosid.id.Idthe agent Id
CompliancemandatoryThis method must be implemented.
MethodgetSubmittingAgent
Description

Gets the submitting agent.

Returnosid.authentication.Agentthe submitting agent
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRequestIds
Description

Gets the Ids of the requests.

Returnosid.id.IdListthe request Ids
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRequests
Description

Gets the requests.

Returnosid.provisioning.RequestListthe requests
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRequestTransactionRecord
Description

Gets the request transaction record corresponding to the given RequestTransaction record Type. This method is used to retrieve an object implementing the requested record. The requestTransactionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(requestTransactionRecordType) is true .

Parametersosid.type.TyperequestTransactionRecordTypethe type of request transaction record to retrieve
Returnosid.provisioning.records.RequestTransactionRecordthe request transaction record
ErrorsNULL_ARGUMENT requestTransactionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requestTransactionRecordType) is false
CompliancemandatoryThis method must be implemented.