OSID - osid.sequencing.ChainForm Service Interface Definition

Interface	osid.sequencing.ChainForm
Implements	`osid.OsidObjectForm`
Used By	`osid.sequencing.ChainAdminSession`
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.
Method	getFifoMetadata
Description	Gets the metadata for the fifo flag.
Return	`osid.Metadata`		metadata for the fifo flag
Compliance	`mandatory`		This method must be implemented.
Method	setFifo
Description	Sets the fifo flag.
Parameters	`boolean`	`fifo`	`true` to append elements to the end of the chain,, `false` to place new elements at the top of the chain
Errors	INVALID_ARGUMENT		`affirmative` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearFifo
Description	Removes the fifo flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getChainFormRecord
Description	Gets the `ChainFormRecord` corresponding to the given chain record `Type`.
Parameters	`osid.type.Type`	`chainRecordType`	a chain record type
Return	`osid.sequencing.records.ChainFormRecord`		the chain form record
Errors	NULL_ARGUMENT		`chainRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(chainRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.