OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.ProvisionableAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes Provisionables. 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 Provisionable, a ProvisionableForm is requested using getProvisionableFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned ProvisionableForm 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 ProvisionableForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProvisionableForm corresponds to an attempted transaction.

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

The delete operations delete Provisionables. To unmap a Provisionable from the current Distributor, the ProvisionableDistributorAssignmentSession should be used. These delete operations attempt to remove the Provisionable 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.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateProvisionables
Description

Tests if this user can create provisionables. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Provisionable 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.

Returnboolean false if Provisionable creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateProvisionableWithRecordTypes
Description

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

Parametersosid.type.Type[]provisionableRecordTypesarray of provisionable record types
Returnboolean true if Provisionable creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT provisionableRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableFormForCreate
Description

Gets the provisionable form for creating new provisionables. A new form should be requested for each create transaction.

Parametersosid.id.IdresourceIdthe Id for the resource
osid.id.IdpoolIdthe Id for the pool
osid.type.Type[]provisionableRecordTypesarray of provisionable record types
Returnosid.provisioning.ProvisionableFormthe provisionable form
ErrorsNOT_FOUND resourceId or poolId is not found
NULL_ARGUMENT resourceId, or poolId, or provisionableRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateProvisionable
Description

Creates a new Provisionable.

Parametersosid.provisioning.ProvisionableFormprovisionableFormthe form for this Provisionable
Returnosid.provisioning.Provisionablethe new Provisionable
ErrorsILLEGAL_STATE provisionableForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT provisionableForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED provisionableForm did not originate from getProvisionableFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateProvisionables
Description

Tests if this user can update provisionables. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Provisionable 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.

Returnboolean false if Provisionable modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableFormForUpdate
Description

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

Parametersosid.id.IdprovisionableIdthe Id of the Provisionable
Returnosid.provisioning.ProvisionableFormthe provisionable form
ErrorsNOT_FOUND provisionableId is not found
NULL_ARGUMENT provisionableId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProvisionable
Description

Updates an existing provisionable.

Parametersosid.provisioning.ProvisionableFormprovisionableFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE provisionableForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT provisionableForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED provisionableForm did not originate from getProvisionableFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteProvisionables
Description

Tests if this user can delete provisionables. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Provisionable 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.

Returnboolean false if Provisionable deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteProvisionable
Description

Deletes a Provisionable.

Parametersosid.id.IdprovisionableIdthe Id of the Provisionable to remove
ErrorsNOT_FOUND provisionableId not found
NULL_ARGUMENT provisionableId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageProvisionableAliases
Description

Tests if this user can manage Id aliases for Provisionables. 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.

Returnboolean false if Provisionable aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasProvisionable
Description

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

Parametersosid.id.IdprovisionableIdthe Id of a Provisionable
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND provisionableId not found
NULL_ARGUMENT provisionableId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.