Interface RequestForm

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

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

  • Method Details

    • getPoolMetadata

      Metadata getPoolMetadata()
      Gets the metadata for the pool.
      Returns:
      metadata for the pool
      Compliance:
      mandatory - This method must be implemented.

    • setPool

      void setPool(Id poolId)
      Sets the pool.
      Parameters:
      poolId - the new pool
      Throws:
      InvalidArgumentException - poolId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearPool

      void clearPool()
      Removes the pool.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRequestedProvisionablesMetadata

      Metadata getRequestedProvisionablesMetadata()
      Gets the metadata for the requested provisionable.
      Returns:
      metadata for the requested provisionable
      Compliance:
      mandatory - This method must be implemented.

    • setRequestedProvisionables

      void setRequestedProvisionables(IdList provisionableIds)
      Sets the requested provisionables. The request will be fulfilled if one of the requested provisionables are available but not result in the provisioning of more than one of the given provisionables.
      Parameters:
      provisionableIds - the new requested provisionables
      Throws:
      InvalidArgumentException - a provisionableId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRequestedProvisionables

      void clearRequestedProvisionables()
      Removes the requested provisionable.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getPositionMetadata

      Metadata getPositionMetadata()
      Gets the metadata for the posiiton.
      Returns:
      metadata for the position
      Compliance:
      mandatory - This method must be implemented.

    • setPosition

      void setPosition(long position)
      Sets the position. A new position inserts at the given place in the queue for queues that support manual positioning.
      Parameters:
      position - the new position
      Throws:
      InvalidArgumentException - position is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearPosition

      void clearPosition()
      Removes the position.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRequestFormRecord

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