Package org.osid.provisioning

package org.osid.provisioning

The Open Service Interface Definitions for the org.osid.provisioning service.

The Provisioning OSID provides a means for requesting and assigning Resources . There are many aspects to this service from the set up of a provisioning system to the acquisition and return of Resources .

Provisionables

A Provisionable represents a resource to be provisioned. A Provisionable is an OsidRelationship between a Resource and a resource Pool . A Pool is a set of like Provisionables that can be assigned. For example, a Resource may be used to represent a car. A Pool may be used to represent an entire set of cars that can be rented. The rental agency may have different classes of cars such as compact cars and full-size cars. Pools may be created for each class of cars.

Requests

A Request is made to request a Provisionable . The requester makes a Request for entry into a Queue . The Queue serves as a wait list for a Provisionable out of one or more Pools . The Request may optionally support a Request for a Provisionable out of a specific Pool , or a Request for a specific set of Provisionables .

A Request may be made for any seat on a flight, any seat in the coach Pool , or any seat within the aisle coach Pool , or one of seats 1B, 1C in the first class Pool .

Multiple Requests may be bundled into a single RequestTransaction . A RequestTransaction is processed atomically in that all Requests are fulfilled or none of the Requests are filled. A RequestTransaction may be made for a Request for a flight from Boston to New York and another Request for a flight from New York to Barcelona. The Barcelona Request should not be processed if there are no available flights to New York.

Provisions

A Provision is the result of fulfilling a Request . A Provision is an OsidRelationship between a Provisionable and a Request . As OsidRelationships , Provisions have effective dates and may optionally require a Provision to be returned. A ProvisionReturn captures information about the return of a Provision .

Brokers

A Broker represents the governance of Queues and Pools . The Broker manages behind-the-scenes operations such as consraints on entering a Queue , the processing of a Queue , and how Provisionables are automatically assigned to Requests . The Broker is the entity to which these various constraints and processing rules are related. While all Queues and Pools may be cataloged in various ways, they belong to a single Broker .

Distributor Cataloging

All Provisions , Requests , Provisionables , Queues , Pools , and Brokers may be organized into federateable OsidCatalogs called Distributors .

Sub Packages

The Provisioning OSID includes a Provisioning Rules OSID for managing constraints and processing rules.

Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.provisioning.batch	The Open Service Interface Definitions for the org.osid.provisioning.batch service.
org.osid.provisioning.records
org.osid.provisioning.rules	The Open Service Interface Definitions for the org.osid.provisioning.rules service.

Interfaces

Class	Description
Broker	A Broker manages queues and pools.
BrokerAdminSession	This session creates, updates, and deletes Brokers .
BrokerDistributorAssignmentSession	This session provides methods to re-assign Brokers to Distributor mappings.
BrokerDistributorSession	This session provides methods to retrieve Broker to Distributor mappings.
BrokerForm	This is the form for creating and updating brokers.
BrokerList	Like all OsidLists , BrokerList provides a means for accessing Broker elements sequentially either one at a time or many at a time.
BrokerLookupSession	This session provides methods for retrieving Broker objects.
BrokerNotificationSession	This session defines methods to receive notifications on adds/changes to Broker objects in this Distributor .
BrokerQuery	This is the query for searching brokers.
BrokerQueryInspector	This is the query inspector for examining broker queries.
BrokerQuerySession	This session provides methods for searching among Broker objects.
BrokerReceiver	The broker receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Broker objects.
BrokerSearch	The search interface for governing broker searches.
BrokerSearchOrder	An interface for specifying the ordering of search results.
BrokerSearchResults	This interface provides a means to capture results of a search.
BrokerSearchSession	This session provides methods for searching among Broker objects.
BrokerSmartDistributorSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Distributor	A Distributor represents a collection of reservoirs.
DistributorAdminSession	This session creates, updates, and deletes Distributors .
DistributorForm	This is the form for creating and updating distributors.
DistributorHierarchyDesignSession	This session defines methods for managing a hierarchy of Distributor objects.
DistributorHierarchySession	This session defines methods for traversing a hierarchy of Distributor objects.
DistributorList	Like all OsidLists , DistributorList provides a means for accessing Distributor elements sequentially either one at a time or many at a time.
DistributorLookupSession	This session provides methods for retrieving Distributor objects.
DistributorNode	This interface is a container for a partial hierarchy retrieval.
DistributorNodeList	Like all OsidLists , DistributorNodeList provides a means for accessing DistributorNode elements sequentially either one at a time or many at a time.
DistributorNotificationSession	This session defines methods to receive notifications on adds/changes to Distributor objects.
DistributorQuery	This is the query for searching distributors.
DistributorQueryInspector	This is the query inspector for examining distributor queries.
DistributorQuerySession	This session provides methods for searching among Distributor objects.
DistributorReceiver	The distributor receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Distributor objects.
DistributorSearch	The search interface for governing distributor searches.
DistributorSearchOrder	An interface for specifying the ordering of search results.
DistributorSearchResults	This interface provides a means to capture results of a search.
DistributorSearchSession	This session provides methods for searching among Distributor objects.
ExchangeSession	This session exchanges an existing provision for a request for another provision via the queue.
MyProvisionNotificationSession	This session defines methods to receive notifications on adds/changes to Provision objects in this Distributor for resources related to the authenticated agent.This also includes existing provisions that may appear or disappear due to changes in the Distributor hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling.
MyProvisionSession	This session defines methods for retrieving supplied provisions related to the queueing of the resource related to the authenticated agent.
MySupplierSession	This session defines methods for retrieving provisions supplied by the resource related to the authenticated agent.
Pool	A Pool represents a set of Resources to be provisioned.
PoolAdminSession	This session creates, updates, and deletes Pools .
PoolDistributorAssignmentSession	This session provides methods to re-assign Pools to Distributor mappings.
PoolDistributorSession	This session provides methods to retrieve Pool to Distributor mappings.
PoolForm	This is the form for creating and updating Pools .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PoolAdminSession .
PoolList	Like all OsidLists , PoolList provides a means for accessing Pool elements sequentially either one at a time or many at a time.
PoolLookupSession	This session provides methods for retrieving Pool objects.
PoolNotificationSession	This session defines methods to receive notifications on adds/changes to Pool objects in this Distributor .
PoolQuery	This is the query for searching pools.
PoolQueryInspector	This is the query inspector for examining pool queries.
PoolQuerySession	This session provides methods for searching among Pool objects.
PoolReceiver	The pool receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Pool objects.
PoolSearch	The search interface for governing pool searches.
PoolSearchOrder	An interface for specifying the ordering of search results.
PoolSearchResults	This interface provides a means to capture results of a search.
PoolSearchSession	This session provides methods for searching among Pool objects.
PoolSmartDistributorSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Provision	A Provision is a relationship between a provisionable and a recipient governed by a broker.
Provisionable	An Provisionable is a provisionable resource.
ProvisionableAdminSession	This session creates, updates, and deletes Provisionables .
ProvisionableDistributorAssignmentSession	This session provides methods to re-assign Provisionables to Distributor mappings.
ProvisionableDistributorSession	This session provides methods to retrieve Provisionable to Distributor provisionables.
ProvisionableForm	This is the form for creating and updating provisionables.
ProvisionableList	Like all OsidLists , ProvisionableList provides a means for accessing Provisionable elements sequentially either one at a time or many at a time.
ProvisionableLookupSession	This session defines methods for retrieving provisionables.
ProvisionableNotificationSession	This session defines methods to receive notifications on adds/changes to Provisionable objects in this dDstributor .
ProvisionableQuery	This is the query for searching provisionables.
ProvisionableQueryInspector	This is the query inspector for examining provisionable queries.
ProvisionableQuerySession	This session provides methods for searching among Provisionable objects.
ProvisionableReceiver	The provisionable receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted provisionables.
ProvisionableSearch	The search interface for governing provisionable searches.
ProvisionableSearchOrder	An interface for specifying the ordering of search results.
ProvisionableSearchResults	This interface provides a means to capture results of a search.
ProvisionableSearchSession	This session provides methods for searching among Provisionable objects.
ProvisionableSmartDistributorSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
ProvisionAdminSession	This session creates, updates, and deletes Provisions .
ProvisionDistributorAssignmentSession	This session provides methods to re-assign Provisions to Distributor mappings.
ProvisionDistributorSession	This session provides methods to retrieve Provision to Distributor mappings.
ProvisionForm	This is the form for creating and updating Provisions .
ProvisioningManager	The provisioning manager provides access to provisioning sessions and provides interoperability tests for various aspects of this service.
ProvisioningProfile	The provisioning profile describes the interoperability among provisioning services.
ProvisioningProxyManager	The provisioning proxy manager provides access to provisioning sessions and provides interoperability tests for various aspects of this service.
ProvisionList	Like all OsidLists , ProvisionList provides a means for accessing Provision elements sequentially either one at a time or many at a time.
ProvisionLookupSession	This session provides methods for retrieving Provision objects.
ProvisionNotificationSession	This session defines methods to receive notifications on adds/changes to Provision objects in this Distributor .
ProvisionQuery	This is the query for searching provisions.
ProvisionQueryInspector	This is the query inspector for examining provision queries.
ProvisionQuerySession	This session provides methods for searching among Provision objects.
ProvisionReceiver	The provision receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Provision objects.
ProvisionReturn	A ProvisionReturn captures data related to the return of a provision.
ProvisionReturnForm	This is the form for creating and updating ProvisionReturns .
ProvisionReturnQuery	This is the query for searching provision returns.
ProvisionReturnQueryInspector	This is the query inspector for examining provision return queries.
ProvisionReturnSearchOrder	An interface for specifying the ordering of search results.
ProvisionReturnSession	This session creates, updates, and deletes ProvisionReturns .
ProvisionSearch	The search interface for governing provision searches.
ProvisionSearchOrder	An interface for specifying the ordering of search results.
ProvisionSearchResults	This interface provides a means to capture results of a search.
ProvisionSearchSession	This session provides methods for searching among Provision objects.
ProvisionSmartDistributorSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Queue	A Queue is a list of resources in line for a provision.
QueueAdminSession	This session creates, updates, and deletes Queues .
QueueDistributorAssignmentSession	This session provides methods to re-assign Queue to Distributor mappings.
QueueDistributorSession	This session provides methods to retrieve Queue to Distributor mappings.
QueueForm	This is the form for creating and updating Queues .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the QueueAdminSession .
QueueList	Like all OsidLists , QueueList provides a means for accessing Queue elements sequentially either one at a time or many at a time.
QueueLookupSession	This session provides methods for retrieving Queues .
QueueNotificationSession	This session defines methods to receive notifications on adds/changes to Queue objects in this Distributor .
QueueQuery	This is the query for searching queues.
QueueQueryInspector	This is the query inspector for examning queue queries.
QueueQuerySession	This session provides methods for searching among Queue objects.
QueueReceiver	The queue receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted queues.
QueueSearch	The search interface for governing queue searches.
QueueSearchOrder	An interface for specifying the ordering of search results.
QueueSearchResults	This interface provides a means to capture results of a search.
QueueSearchSession	This session provides methods for searching among Queue objects.
QueueSmartDistributorSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Request	A Request is an entry in a Queue .
RequestAdminSession	This session creates, updates, and deletes Requests .
RequestDistributorAssignmentSession	This session provides methods to re-assign Requests to Distributor mappings.
RequestDistributorSession	This session provides methods to retrieve Request to Distributor mappings.
RequestForm	This is the form for creating and updating Requests .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RequestAdminSession .
RequestList	Like all OsidLists , RequestList provides a means for accessing Request elements sequentially either one at a time or many at a time.
RequestLookupSession	This session provides methods for retrieving Request relationships.
RequestNotificationSession	This session defines methods to receive notifications on adds/changes to Request objects in this Distributor .
RequestQuery	This is the query for searching requests.
RequestQueryInspector	This is the query inspector for examining request queries.
RequestQuerySession	This session provides methods for searching among Request objects.
RequestReceiver	The request receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Request objects.
RequestSearch	The search interface for governing request searches.
RequestSearchOrder	An interface for specifying the ordering of search results.
RequestSearchResults	This interface provides a means to capture results of a search.
RequestSearchSession	This session provides methods for searching among Request objects.
RequestSmartDistributorSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
RequestTransaction	A RequestTransaction is set of Requests .
RequestTransactionAdminSession	This session creates, updates, and deletes RequestTransactions .
RequestTransactionForm	This is the form for creating and updating RequestTransactionss .
RequestTransactionList	Like all OsidLists , RequestTransactionList provides a means for accessing RequestTransaction elements sequentially either one at a time or many at a time.
RequestTransactionLookupSession	This session provides methods for retrieving RequestTransactions .
RequestTransactionNotificationSession	This session defines methods to receive notifications on adds/changes to RequestTransaction objects in this Distributor .
RequestTransactionQuery	This is the query for searching requests.
RequestTransactionQueryInspector	This is the query inspector for examining request transaction queries.
RequestTransactionQuerySession	This session provides methods for searching among RequestTransaction objects.
RequestTransactionReceiver	The request transaction receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted RequestTransaction objects.
RequestTransactionSearch	The search interface for governing request transaction searches.
RequestTransactionSearchOrder	An interface for specifying the ordering of search results.
RequestTransactionSearchResults	This interface provides a means to capture results of a search.
RequestTransactionSearchSession	This session provides methods for searching among RequestTransaction objects.
RequestTransactionSmartDistributorSession	This session manages queries and sequencing to create "smart" dynamic catalogs.