public interface FunctionForm extends OsidRuleForm
This is the form for creating and updating Functions.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
FunctionAdminSession.
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 |
clearQualifierHierarchy()
Clears the qualifier hierarchy.
|
FunctionFormRecord |
getFunctionFormRecord(Type functionRecordType)
Gets the
FunctionFormRecord corresponding to the given
function record Type. |
Metadata |
getQualifierHierarchyMetadata()
Gets the metadata for a qualifier hierarchy.
|
void |
setQualifierHierarchy(Id qualifierHierarchyId)
Sets the qualifier hierarchy.
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getQualifierHierarchyMetadata()
mandatory
- This method must be implemented. void setQualifierHierarchy(Id qualifierHierarchyId)
qualifierHierarchyId
- the new qualifier hierarchyInvalidArgumentException
- qualifierHierarchyId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- qualifierHierarchyId
is null
mandatory
- This method must be implemented. void clearQualifierHierarchy()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. FunctionFormRecord getFunctionFormRecord(Type functionRecordType) throws OperationFailedException
FunctionFormRecord
corresponding to the given
function record Type.
functionRecordType
- the function record typeNullArgumentException
- functionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(functionRecordType)
is false
mandatory
- This method must be implemented.