Interface ProvisionableForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
ProvisionableBatchForm
public interface ProvisionableForm extends OsidRelationshipForm

This is the form for creating and updating provisionables. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProvisionableAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getProvisionableFormRecord

      ProvisionableFormRecord getProvisionableFormRecord(Type provisionableRecordType) throws OperationFailedException
      Gets the ProvisionableFormRecord corresponding to the given provisionable record Type .
      Parameters:
      provisionableRecordType - a provisionable record type
      Returns:
      the provisionable form record
      Throws:
      NullArgumentException - provisionableRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(provisionableRecordType) is false
      Compliance:
      mandatory - This method must be implemented.