OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.QueueForm
Implementsosid.OsidGovernatorForm
osid.OsidSubjugateableForm
Description

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. For each data element that may be set, metadata may be examined to provide display hints or data constraints. Some data may be automatically derived from the queue segments.

MethodgetCanSpecifyProvisionableMetadata
Description

Gets the metadata for the can request provisionables flag.

Returnosid.Metadatametadata for the can request provisionables flag
CompliancemandatoryThis method must be implemented.
MethodsetCanSpecifyProvisionable
Description

Sets the can request provisionables flag.

ParameterscardinalcanRequestthe new can request provisionables flag
ErrorsINVALID_ARGUMENT canRequest is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCanSpecifyProvisionable
Description

Removes the can request provisionables flag.

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

Gets the QueueFormRecord corresponding to the given queue record Type.

Parametersosid.type.TypequeueRecordTypea queue record type
Returnosid.provisioning.records.QueueFormRecordthe queue form record
ErrorsNULL_ARGUMENT queueRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueRecordType) is false
CompliancemandatoryThis method must be implemented.