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

A Request is an entry in a Queue. It is a relationship berween a Queue and a Resource qualified by a Pool. A request is inactive if the queue is disabled.

MethodgetRequestTransactionId
Description

Gets the Id of the transaction in which this request is a part. Requests can be made individually or as part of a transaction group to provide an atomic compound request.

Returnosid.id.Idthe request transaction Id
CompliancemandatoryThis method must be implemented.
MethodgetRequestTransaction
Description

Gets the Id of the transaction in which this request is a part. Requests can be made individually or as part of a transaction group to provide an atomic compound request.

Returnosid.provisioning.RequestTransactionthe request transaction
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetQueueId
Description

Gets the Id of the queue.

Returnosid.id.Idthe queue Id
CompliancemandatoryThis method must be implemented.
MethodgetQueue
Description

Gets the queue.

Returnosid.provisioning.Queuethe queue
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRequestDate
Description

Gets the date of the request.

Returnosid.calendaring.DateTimethe request date
CompliancemandatoryThis method must be implemented.
MethodgetRequesterId
Description

Gets the Id of the queued resource.

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

Gets the queued resource.

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

Gets the Id of the requesting agent.

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

Gets the requesting agent.

Returnosid.authentication.Agentthe requesting agent
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasPool
Description

Tests if this request is qualified by a pool. An unqualified request may be allocated out of any pool in the broker.

Returnboolean true if this request has a pool, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPoolId
Description

Gets the Id of the pool.

Returnosid.id.Idthe pool Id
ErrorsILLEGAL_STATE hasPool() is false
CompliancemandatoryThis method must be implemented.
MethodgetPool
Description

Gets the pool.

Returnosid.provisioning.Poolthe pool
ErrorsILLEGAL_STATE hasPool() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRequestedProvisionableIds
Description

Gets the Ids of the requested provisionables.

Returnosid.id.IdListthe requested provisionable Ids
CompliancemandatoryThis method must be implemented.
MethodgetRequestedProvisionables
Description

Gets the requested provisionables.

Returnosid.provisioning.ProvisionableListthe requested provisionables
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisExchange
Description

Tests if this request was created to exchange a provision.

Returnboolean true if this request is an exchange request, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetExchangeProvisionId
Description

Gets the Id of the provision to be exchanged if this request is provisioned.

Returnosid.id.Idthe exchange provision Id
ErrorsILLEGAL_STATE isExchange() is false
CompliancemandatoryThis method must be implemented.
MethodgetExchangeProvision
Description

Gets the provision to be exchanged if this request is provisioned.

Returnosid.provisioning.Provisionthe exchange provision
ErrorsILLEGAL_STATE isExchange() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisProvisionResult
Description

Tests if this request was created as a result of another provision.

Returnboolean true if this request is a provision result, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOriginProvisionId
Description

Gets the Id of the provision that resulted in this request.

Returnosid.id.Idthe origin provision Id
ErrorsILLEGAL_STATE isProvisionResult() is f alse
CompliancemandatoryThis method must be implemented.
MethodgetOriginProvision
Description

Gets the provision that resulted in this request.

Returnosid.provisioning.Provisionthe origin provision
ErrorsILLEGAL_STATE isProvisionResult() is f alse
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasPosition
Description

Tests if this request has a position in the queue. A position may be indicate the rank of the request among waiting requests for the same pool.

Returnbooleantrue if this request has a position, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPosition
Description

Gets the position of this request in the queue. A position may be indicate the rank of the request among waiting request for the same pool.

Returnintegerthe position
ErrorsILLEGAL_STATE hasPosition() is false
CompliancemandatoryThis method must be implemented.
MethodhasEWA
Description

Tests if there is an estimated waiting time for a provision out of the pool.

Returnboolean true if this request has an estimated time, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEWA
Description

Gets the estimated waiting time for a provision out of the pool.

Returnosid.calendaring.Durationthe estimated waiting time
ErrorsILLEGAL_STATE hasEWA() is false
CompliancemandatoryThis method must be implemented.
MethodgetRequestRecord
Description

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

Parametersosid.type.TyperequestRecordTypethe type of request record to retrieve
Returnosid.provisioning.records.RequestRecordthe request record
ErrorsNULL_ARGUMENT requestRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requestRecordType) is false
CompliancemandatoryThis method must be implemented.