OSID — Provisioning Entities

Provision

Osid Relationship

A Provision is a relationship between a provisionable and a recipient governed by a broker.

Like all OsidObjects, Provision is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Description
`brokerId`	id	the broker `Id`
`broker`	Broker	the broker
`provisionableId`	id	the provisionable `Id`
`provisionable`	Provisionable	the provisionable
`recipientId`	id	the resource `Id`
`recipient`	Resource	the resource
`provisionedByRequest`	boolean	`true` if a request is available, false otherwise
`requestId`	id	the request `Id`
`request`	Request	the request
`provisionDate`	datetime	the provision date
`isLeased`	boolean	`true` if this is a lease, `false` if the provision is permanent
`mustReturn`	boolean	`true` if this must be returned, `false` otherwise
`hasDueDate`	boolean	`true` if this provision has a due date, `false` otherwise
`dueDate`	datetime	the due date
`hasCost`	boolean	`true` if there is a cost, `false` otherwise
`cost`	Currency	the cost
`hasRate`	boolean	`true` if there is a rate, false otherwise
`rateAmount`	Currency	the rate amount
`ratePeriod`	duration	the time period
`isReturned`	boolean	`true` if this provision has been returned, `false` otherwise
`provisionReturn`	ProvisionReturn	the return

Provision Return

Osid Object Subjugateable

A ProvisionReturn captures data related to the return of a provision.

Like all OsidObjects, ProvisionReturn is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Description
`returnDate`	datetime	the date returned
`returnerId`	id	the resource `Id`
`returner`	Resource	the returner
`returningAgentId`	id	the resource `Id`
`returningAgent`	Agent	the agent

Queue

Osid Governator Subjugateable

A Queue is a list of resources in line for a provision. The rule indicates how requests are processed in this queue.

Like all OsidObjects, Queue is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise

Name	Syntax	Many	Description
`brokerId`	id		the broker `Id`
`broker`	Broker		the broker
`managerIds`	id	⋆	the manager `Ids`
`managers`	Resource	⋆	the managers
`hasSize`	boolean		`true` if a queue size is available, `false` otherwise
`size`	cardinal		the size
`hasEWA`	boolean		`true` if an ewa is available, `false` otherwise
`eWA`	duration		the ewa
`canSpecifyProvisionable`	boolean		`true` if provisionables can be specified, `false` otherwise

Request

Osid Relationship

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.

Like all OsidObjects, Request is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Many	Description
`requestTransactionId`	id		the request transaction `Id`
`requestTransaction`	RequestTransaction		the request transaction
`queueId`	id		the queue `Id`
`queue`	Queue		the queue
`requestDate`	datetime		the request date
`requesterId`	id		the resource `Id`
`requester`	Resource		the resource
`requestingAgentId`	id		the agent `Id`
`requestingAgent`	Agent		the requesting agent
`hasPool`	boolean		`true` if this request has a pool, `false` otherwise
`poolId`	id		the pool `Id`
`pool`	Pool		the pool
`requestedProvisionableIds`	id	⋆	the requested provisionable `Ids`
`requestedProvisionables`	Provisionable	⋆	the requested provisionables
`isExchange`	boolean		`true` if this request is an exchange request, `false` otherwise
`exchangeProvisionId`	id		the exchange provision `Id`
`exchangeProvision`	Provision		the exchange provision
`isProvisionResult`	boolean		`true` if this request is a provision result, `false` otherwise
`originProvisionId`	id		the origin provision `Id`
`originProvision`	Provision		the origin provision
`hasPosition`	boolean		true if this request has a position, false otherwise
`position`	integer		the position
`hasEWA`	boolean		`true` if this request has an estimated time, `false` otherwise
`eWA`	duration		the estimated waiting time

Request Transaction

Osid Relationship

A RequestTransaction is set of Requests.

Like all OsidObjects, RequestTransaction is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Many	Description
`brokerId`	id		the broker `Id`
`broker`	Broker		the broker
`submitDate`	datetime		the transaction submit date
`submitterId`	id		the resource `Id`
`submitter`	Resource		the resource
`submittingAgentId`	id		the agent `Id`
`submittingAgent`	Agent		the submitting agent
`requestIds`	id	⋆	the request `Ids`
`requests`	Request	⋆	the requests

Pool

Osid Governator Subjugateable

A Pool represents a set of Resources to be provisioned. The rule indicates how resources are provisioned.

Like all OsidObjects, Pool is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise

Name	Syntax	Many	Description
`brokerId`	id		the broker `Id`
`broker`	Broker		the broker
`supplierIds`	id	⋆	the supplier `Ids`
`suppliers`	Resource	⋆	the suppliers
`hasSize`	boolean		`true` if a queue size is available, `false` otherwise
`size`	cardinal		the size

Provisionable

Osid Relationship

An Provisionable is a provisionable resource. A provisionable is inactive if the pool is disabled.

Like all OsidObjects, Provisionable is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Description
`poolId`	id	the pool `Id`
`pool`	Pool	the pool
`resourceId`	id	the resource `Id`
`resource`	Resource	the resource
`use`	cardinal	the position

Broker

Osid Governator

A Broker manages queues and pools.

Like all OsidObjects, Broker is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise

Name	Syntax	Many	Description
`brokerageIds`	id	⋆	the brokerage `Ids`
`brokerages`	Resource	⋆	the brokerages

Distributor

Osid Catalog

A Distributor represents a collection of reservoirs.

Like all OsidObjects, Distributor is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license

Provisioning

Provisionables

Requests

Provisions

Brokers

Distributor Cataloging

Sub Packages

Provision

Provision Return

Queue

Request

Request Transaction

Pool

Provisionable

Broker

Distributor