OSID Logo
OSID Specifications
tracking package
Version 3.1.0
Interfaceosid.tracking.QueueForm
Implementsosid.OsidGovernatorForm
Implemented Byosid.tracking.batch.QueueBatchForm
Used Byosid.tracking.QueueAdminSession
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.

MethodgetManagersMetadata
Description

Gets the metadata for the managers.

Returnosid.Metadata metadata for the managers
Compliancemandatory This method must be implemented.
MethodsetManagers
Description

Sets the managers.

Parametersosid.id.IdListmanagerIds the new managers
ErrorsINVALID_ARGUMENT managerIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT managerIds is null
Compliancemandatory This method must be implemented.
MethodclearManagers
Description

Removes the managers.

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

Gets the QueueFormRecord corresponding to the given queue record Type.

Parametersosid.type.TypequeueRecordType a queue record type
Returnosid.tracking.records.QueueFormRecord the queue form record
ErrorsNULL_ARGUMENT queueRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(queueRecordType) is false
Compliancemandatory This method must be implemented.