org.osid.sequencing

Interface ChainForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

public interface ChainForm
extends OsidObjectForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearFifo() Removes the fifo flag.
ChainFormRecord	getChainFormRecord(Type chainRecordType) Gets the ChainFormRecord corresponding to the given chain record Type.
Metadata	getFifoMetadata() Gets the metadata for the fifo flag.
void	setFifo(boolean fifo) Sets the fifo flag.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getFifoMetadata

Metadata getFifoMetadata()

Gets the metadata for the fifo flag.

Returns:

metadata for the fifo flag

Compliance:

mandatory - This method must be implemented.

setFifo

void setFifo(boolean fifo)

Sets the fifo flag.

Parameters:

fifo - true to append elements to the end of the chain,, false to place new elements at the top of the chain

Throws:

InvalidArgumentException - affirmative is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearFifo

void clearFifo()

Removes the fifo flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getChainFormRecord

ChainFormRecord getChainFormRecord(Type chainRecordType)
                                   throws OperationFailedException

Gets the ChainFormRecord corresponding to the given chain record Type.

Parameters:

chainRecordType - a chain record type

Returns:

the chain form record

Throws:

NullArgumentException - chainRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(chainRecordType) is false

Compliance:

mandatory - This method must be implemented.