Interface BookBatchForm

All Superinterfaces:
BookForm, Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable
public interface BookBatchForm extends BookForm

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

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

  • Method Details

    • getBookId

      Id getBookId()
      Gets the Book Id of the book to be updated if this is an update transaction.
      Returns:
      the book Id
      Throws:
      IllegalStateException - isForUpdate() is false
      Compliance:
      mandatory - This method must be implemented.

    • getParentsMetadata

      Metadata getParentsMetadata()
      Gets the metadata for setting the hierarchical parents of this book.
      Returns:
      metadata for the parents
      Compliance:
      mandatory - This method must be implemented.

    • setParents

      void setParents(Id[] parents)
      Sets the hierarchical parents.
      Parameters:
      parents - the new parents
      Throws:
      InvalidArgumentException - parents is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - parents is null
      Compliance:
      mandatory - This method must be implemented.

    • clearParents

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