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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getFifoMetadata()
mandatory
- This method must be implemented. void setFifo(boolean fifo)
fifo
- true
to append elements to the end of the
chain,, false
to place new elements at the top
of the chainInvalidArgumentException
- affirmative
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearFifo()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ChainFormRecord getChainFormRecord(Type chainRecordType) throws OperationFailedException
ChainFormRecord
corresponding to the given
chain record Type.
chainRecordType
- a chain record typeNullArgumentException
- chainRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(chainRecordType)
is false
mandatory
- This method must be implemented.