Interface FunctionForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable
All Known Subinterfaces:
FunctionBatchForm
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.

Like all OsidForms, FunctionForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getQualifierHierarchyMetadata

      Metadata getQualifierHierarchyMetadata()
      Gets the metadata for a qualifier hierarchy.
      Returns:
      metadata for the qualifier hierarchy
      Compliance:
      mandatory - This method must be implemented.

    • setQualifierHierarchy

      void setQualifierHierarchy(Id qualifierHierarchyId)
      Sets the qualifier hierarchy.
      Parameters:
      qualifierHierarchyId - the new qualifier hierarchy
      Throws:
      InvalidArgumentException - qualifierHierarchyId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - qualifierHierarchyId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearQualifierHierarchy

      void clearQualifierHierarchy()
      Clears the qualifier hierarchy.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionFormRecord

      FunctionFormRecord getFunctionFormRecord(Type functionRecordType) throws OperationFailedException
      Gets the FunctionFormRecord corresponding to the given function record Type.
      Parameters:
      functionRecordType - the function record type
      Returns:
      the function form record
      Throws:
      NullArgumentException - functionRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(functionRecordType) is false
      Compliance:
      mandatory - This method must be implemented.