Interface ProvisionAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ProvisionBatchAdminSession

public interface ProvisionAdminSession
extends OsidSession

This session creates, updates, and deletes Provisions . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Provision , a ProvisionForm is requested using getProvisionFormForCreate() specifying the desired broker, provisionable, resource, and record Types or none if no record Types are needed. The returned ProvisionForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the ProvisionForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProvisionForm corresponds to an attempted transaction.

For updates, ProvisionForms are requested to the Provision Id that is to be updated using getProvisionFormForUpdate() . Similarly, the ProvisionForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ProvisionForm can only be used once for a successful update and cannot be reused.

The delete operations delete Provisions . To unmap a Provision from the current Distributor , the ProvisionDistributorAssignmentSession should be used. These delete operations attempt to remove the Provision itself thus removing it from all known Distributor catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasProvision(Id provisionId, Id aliasId)	Adds an Id to a Provision for the purpose of creating compatibility.
boolean	canCreateProvisions()	Tests if this user can create Provisions .
boolean	canCreateProvisionWithRecordTypes(Type[] provisionRecordTypes)	Tests if this user can create a single Provision using the desired record types.
boolean	canDeleteProvisions()	Tests if this user can delete Provisions .
boolean	canManageProvisionAliases()	Tests if this user can manage Id aliases for Provisions .
boolean	canUpdateProvisions()	Tests if this user can update Provisions .
Provision	createProvision(ProvisionForm provisionForm)	Creates a new Provision .
void	deleteProvision(Id provisionId)	Deletes a Provision .
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
ProvisionForm	getProvisionFormForCreate(Id brokerId, Id provisionableId, Id resourceId, Type[] provisionRecordTypes)	Gets the provision form for creating new provisions.
ProvisionForm	getProvisionFormForUpdate(Id provisionId)	Gets the provision form for updating an existing provision.
void	updateProvision(ProvisionForm provisionForm)	Updates an existing provision.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                    throws OperationFailedException,
PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateProvisions

boolean canCreateProvisions()

Tests if this user can create Provisions . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Provision will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:

false if Provision creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateProvisionWithRecordTypes

boolean canCreateProvisionWithRecordTypes(Type[] provisionRecordTypes)

Tests if this user can create a single Provision using the desired record types. While ProvisioningManager.getProvisionRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Provision . Providing an empty array tests if a Provision can be created with no records.

Parameters:

provisionRecordTypes - array of provision record types

Returns:

true if Provision creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - provisionRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getProvisionFormForCreate

ProvisionForm getProvisionFormForCreate(Id brokerId,
 Id provisionableId,
 Id resourceId,
 Type[] provisionRecordTypes)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the provision form for creating new provisions. A new form should be requested for each create transaction.

Parameters:

brokerId - the Id for the broker

provisionableId - the Id for the provisionable

resourceId - the Id for the resource

provisionRecordTypes - array of provision record types

Returns:

the provision form

Throws:

NotFoundException - brokerId, provisionableId , or resourceId is not found

NullArgumentException - brokerId, provisionableId, resourceId , or provisionRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createProvision

Provision createProvision(ProvisionForm provisionForm)
                   throws OperationFailedException,
PermissionDeniedException

Creates a new Provision .

Parameters:

provisionForm - the form for this Provision

Returns:

the new Provision

Throws:

IllegalStateException - provisionForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - provisionForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - provisionForm did not originate from getProvisionFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateProvisions

boolean canUpdateProvisions()

Tests if this user can update Provisions . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Provision will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:

false if Provision modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getProvisionFormForUpdate

ProvisionForm getProvisionFormForUpdate(Id provisionId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the provision form for updating an existing provision. A new provision form should be requested for each update transaction.

Parameters:

provisionId - the Id of the Provision

Returns:

the provision form

Throws:

NotFoundException - provisionId is not found

NullArgumentException - provisionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProvision

void updateProvision(ProvisionForm provisionForm)
              throws OperationFailedException,
PermissionDeniedException

Updates an existing provision.

Parameters:

provisionForm - the form containing the elements to be updated

Throws:

IllegalStateException - provisionForm already used in an update transatcion

InvalidArgumentException - the form contains an invalid value

NullArgumentException - provisionForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - provisionForm did not originate from getProvisionFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteProvisions

boolean canDeleteProvisions()

Tests if this user can delete Provisions . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Provision will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:

false if Provision deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteProvision

void deleteProvision(Id provisionId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Provision .

Parameters:

provisionId - the Id of the Provision to remove

Throws:

NotFoundException - provisionId not found

NullArgumentException - provisionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageProvisionAliases

boolean canManageProvisionAliases()

Tests if this user can manage Id aliases for Provisions . A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Provision aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasProvision

void aliasProvision(Id provisionId,
 Id aliasId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Provision for the purpose of creating compatibility. The primary Id of the Provision is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another provision, it is reassigned to the given provision Id .

Parameters:

provisionId - the Id of a Provision

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - provisionId not found

NullArgumentException - provisionId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.