Interface | osid.provisioning.Request | ||
---|---|---|---|
Implements | osid.OsidRelationship | ||
Description |
A | ||
Method | getRequestTransactionId | ||
Description |
Gets the | ||
Return | osid.id.Id | the request transaction Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestTransaction | ||
Description |
Gets the | ||
Return | osid.provisioning.RequestTransaction | the request transaction | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the queue Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueue | ||
Description |
Gets the queue. | ||
Return | osid.provisioning.Queue | the queue | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestDate | ||
Description |
Gets the date of the request. | ||
Return | osid.calendaring.DateTime | the request date | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequesterId | ||
Description |
Gets the | ||
Return | osid.id.Id | the resource Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequester | ||
Description |
Gets the queued resource. | ||
Return | osid.resource.Resource | the resource | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestingAgentId | ||
Description |
Gets the | ||
Return | osid.id.Id | the agent Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestingAgent | ||
Description |
Gets the requesting agent. | ||
Return | osid.authentication.Agent | the requesting agent | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | hasPool | ||
Description |
Tests if this request is qualified by a pool. An unqualified request may be allocated out of any pool in the broker. | ||
Return | boolean | true if this request has a pool, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolId | ||
Description |
Gets the | ||
Return | osid.id.Id | the pool Id | |
Errors | ILLEGAL_STATE | hasPool() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getPool | ||
Description |
Gets the pool. | ||
Return | osid.provisioning.Pool | the pool | |
Errors | ILLEGAL_STATE | hasPool() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequestedProvisionableIds | ||
Description |
Gets the | ||
Return | osid.id.IdList | the requested provisionable Ids | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestedProvisionables | ||
Description |
Gets the requested provisionables. | ||
Return | osid.provisioning.ProvisionableList | the requested provisionables | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | isExchange | ||
Description |
Tests if this request was created to exchange a provision. | ||
Return | boolean | true if this request is an exchange request, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getExchangeProvisionId | ||
Description |
Gets the | ||
Return | osid.id.Id | the exchange provision Id | |
Errors | ILLEGAL_STATE | isExchange() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getExchangeProvision | ||
Description |
Gets the provision to be exchanged if this request is provisioned. | ||
Return | osid.provisioning.Provision | the exchange provision | |
Errors | ILLEGAL_STATE | isExchange() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | isProvisionResult | ||
Description |
Tests if this request was created as a result of another provision. | ||
Return | boolean | true if this request is a provision result, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOriginProvisionId | ||
Description |
Gets the | ||
Return | osid.id.Id | the origin provision Id | |
Errors | ILLEGAL_STATE | isProvisionResult() is f alse | |
Compliance | mandatory | This method must be implemented. | |
Method | getOriginProvision | ||
Description |
Gets the provision that resulted in this request. | ||
Return | osid.provisioning.Provision | the origin provision | |
Errors | ILLEGAL_STATE | isProvisionResult() is f alse | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | hasPosition | ||
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. | ||
Return | boolean | true if this request has a position, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPosition | ||
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. | ||
Return | integer | the position | |
Errors | ILLEGAL_STATE | hasPosition() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasEWA | ||
Description |
Tests if there is an estimated waiting time for a provision out of the pool. | ||
Return | boolean | true if this request has an estimated time, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEWA | ||
Description |
Gets the estimated waiting time for a provision out of the pool. | ||
Return | osid.calendaring.Duration | the estimated waiting time | |
Errors | ILLEGAL_STATE | hasEWA() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestRecord | ||
Description |
Gets the request record corresponding to the given
| ||
Parameters | osid.type.Type | requestRecordType | the type of request record to retrieve |
Return | osid.provisioning.records.RequestRecord | the request record | |
Errors | NULL_ARGUMENT | requestRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(requestRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |