OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating chains. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ChainAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetFifoMetadata
Description

Gets the metadata for the fifo flag.

Returnosid.Metadatametadata for the fifo flag
CompliancemandatoryThis method must be implemented.
MethodsetFifo
Description

Sets the fifo flag.

Parametersbooleanfifo true to append elements to the end of the chain,, false to place new elements at the top of the chain
ErrorsINVALID_ARGUMENT affirmative is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearFifo
Description

Removes the fifo flag.

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

Gets the ChainFormRecord corresponding to the given chain record Type.

Parametersosid.type.TypechainRecordTypea chain record type
Returnosid.sequencing.records.ChainFormRecordthe chain form record
ErrorsNULL_ARGUMENT chainRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(chainRecordType) is false
CompliancemandatoryThis method must be implemented.