public interface Request extends OsidRelationship
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.
Modifier and Type | Method and Description |
---|---|
Duration |
getEWA()
Gets the estimated waiting time for a provision out of the pool.
|
Provision |
getExchangeProvision()
Gets the provision to be exchanged if this request is provisioned.
|
Id |
getExchangeProvisionId()
Gets the
Id of the provision to be exchanged if this
request is provisioned. |
Provision |
getOriginProvision()
Gets the provision that resulted in this request.
|
Id |
getOriginProvisionId()
Gets the
Id of the provision that resulted in this
request. |
Pool |
getPool()
Gets the pool.
|
Id |
getPoolId()
Gets the
Id of the pool. |
long |
getPosition()
Gets the position of this request in the queue.
|
Queue |
getQueue()
Gets the queue.
|
Id |
getQueueId()
Gets the
Id of the queue. |
DateTime |
getRequestDate()
Gets the date of the request.
|
IdList |
getRequestedProvisionableIds()
Gets the
Ids of the requested provisionables. |
ProvisionableList |
getRequestedProvisionables()
Gets the requested provisionables.
|
Resource |
getRequester()
Gets the queued resource.
|
Id |
getRequesterId()
Gets the
Id of the queued resource. |
Agent |
getRequestingAgent()
Gets the requesting agent.
|
Id |
getRequestingAgentId()
Gets the
Id of the requesting agent. |
RequestRecord |
getRequestRecord(Type requestRecordType)
Gets the request record corresponding to the given
Request
record Type. |
RequestTransaction |
getRequestTransaction()
Gets the
Id of the transaction in which this request is
a part. |
Id |
getRequestTransactionId()
Gets the
Id of the transaction in which this request is
a part. |
boolean |
hasEWA()
Tests if there is an estimated waiting time for a provision out of the
pool.
|
boolean |
hasPool()
Tests if this request is qualified by a pool.
|
boolean |
hasPosition()
Tests if this request has a position in the queue.
|
boolean |
isExchange()
Tests if this request was created to exchange a provision.
|
boolean |
isProvisionResult()
Tests if this request was created as a result of another provision.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getRequestTransactionId()
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. Id
mandatory
- This method must be implemented. RequestTransaction getRequestTransaction() throws OperationFailedException
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.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getQueueId()
Id
of the queue. Id
mandatory
- This method must be implemented. Queue getQueue() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getRequestDate()
mandatory
- This method must be implemented. Id getRequesterId()
Id
of the queued resource. Id
mandatory
- This method must be implemented. Resource getRequester() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getRequestingAgentId()
Id
of the requesting agent. Id
mandatory
- This method must be implemented. Agent getRequestingAgent() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasPool()
true
if this request has a pool, false
otherwisemandatory
- This method must be implemented. Id getPoolId()
Id
of the pool. Id
IllegalStateException
- hasPool()
is
false
mandatory
- This method must be implemented. Pool getPool() throws OperationFailedException
IllegalStateException
- hasPool()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getRequestedProvisionableIds()
Ids
of the requested provisionables. Ids
mandatory
- This method must be implemented. ProvisionableList getRequestedProvisionables() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isExchange()
true
if this request is an exchange request,
false
otherwisemandatory
- This method must be implemented. Id getExchangeProvisionId()
Id
of the provision to be exchanged if this
request is provisioned. Id
IllegalStateException
- isExchange()
is
false
mandatory
- This method must be implemented. Provision getExchangeProvision() throws OperationFailedException
IllegalStateException
- isExchange()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isProvisionResult()
true
if this request is a provision result,
false
otherwisemandatory
- This method must be implemented. Id getOriginProvisionId()
Id
of the provision that resulted in this
request. Id
IllegalStateException
- isProvisionResult()
is f alse
mandatory
- This method must be implemented. Provision getOriginProvision() throws OperationFailedException
IllegalStateException
- isProvisionResult()
is f alse
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasPosition()
mandatory
- This method must be implemented. long getPosition()
IllegalStateException
- hasPosition()
is
false
mandatory
- This method must be implemented. boolean hasEWA()
true
if this request has an estimated time,
false
otherwisemandatory
- This method must be implemented. Duration getEWA()
IllegalStateException
- hasEWA()
is
false
mandatory
- This method must be implemented. RequestRecord getRequestRecord(Type requestRecordType) throws OperationFailedException
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
.requestRecordType
- the type of request record to retrieveNullArgumentException
- requestRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requestRecordType)
is false
mandatory
- This method must be implemented.