OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.RequestForm
Implementsosid.OsidRelationshipForm
Description

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. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetPoolMetadata
Description

Gets the metadata for the pool.

Returnosid.Metadatametadata for the pool
CompliancemandatoryThis method must be implemented.
MethodsetPool
Description

Sets the pool.

Parametersosid.id.IdpoolIdthe new pool
ErrorsINVALID_ARGUMENT poolId is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearPool
Description

Removes the pool.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRequestedProvisionablesMetadata
Description

Gets the metadata for the requested provisionable.

Returnosid.Metadatametadata for the requested provisionable
CompliancemandatoryThis method must be implemented.
MethodsetRequestedProvisionables
Description

Sets the requested provisionables. The request will be fulfilled if one of the requested provisionables are available but not result in the provisioning of more than one of the given provisionables.

Parametersosid.id.IdListprovisionableIdsthe new requested provisionables
ErrorsINVALID_ARGUMENTa provisionableId is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearRequestedProvisionables
Description

Removes the requested provisionable.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPositionMetadata
Description

Gets the metadata for the posiiton.

Returnosid.Metadatametadata for the position
CompliancemandatoryThis method must be implemented.
MethodsetPosition
Description

Sets the position. A new position inserts at the given place in the queue for queues that support manual positioning.

Parametersintegerpositionthe new position
ErrorsINVALID_ARGUMENT position is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearPosition
Description

Removes the position.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRequestFormRecord
Description

Gets the RequestFormRecord corresponding to the given request record Type.

Parametersosid.type.TyperequestRecordTypea request record type
Returnosid.provisioning.records.RequestFormRecordthe request form record
ErrorsNULL_ARGUMENT requestRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requestRecordType) is false
CompliancemandatoryThis method must be implemented.