Interface AssetForm

All Superinterfaces:
Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable
All Known Subinterfaces:
AssetBatchForm
public interface AssetForm extends OsidObjectForm, OsidAggregateableForm, OsidSourceableForm

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

  • Method Details

    • getTitleMetadata

      Metadata getTitleMetadata()
      Gets the metadata for an asset title.
      Returns:
      metadata for the title
      Compliance:
      mandatory - This method must be implemented.

    • setTitle

      void setTitle(String title)
      Sets the title.
      Parameters:
      title - the new title
      Throws:
      InvalidArgumentException - title is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - title is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTitle

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

    • getPublicDomainMetadata

      Metadata getPublicDomainMetadata()
      Gets the metadata for the public domain flag.
      Returns:
      metadata for the public domain
      Compliance:
      mandatory - This method must be implemented.

    • setPublicDomain

      void setPublicDomain(boolean publicDomain)
      Sets the public domain flag.
      Parameters:
      publicDomain - the public domain status
      Throws:
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearPublicDomain

      void clearPublicDomain()
      Removes the public domain status.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCopyrightMetadata

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

    • setCopyright

      void setCopyright(String copyright)
      Sets the copyright.
      Parameters:
      copyright - the new copyright
      Throws:
      InvalidArgumentException - copyright is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - copyright is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCopyright

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

    • getCopyrightRegistrationMetadata

      Metadata getCopyrightRegistrationMetadata()
      Gets the metadata for the copyright registration.
      Returns:
      metadata for the copyright registration
      Compliance:
      mandatory - This method must be implemented.

    • setCopyrightRegistration

      void setCopyrightRegistration(String registration)
      Sets the copyright registration.
      Parameters:
      registration - the new copyright registration
      Throws:
      InvalidArgumentException - copyright is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - copyright is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCopyrightRegistration

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

    • getDistributeVerbatimMetadata

      Metadata getDistributeVerbatimMetadata()
      Gets the metadata for the distribute verbatim rights flag.
      Returns:
      metadata for the distribution rights fields
      Compliance:
      mandatory - This method must be implemented.

    • setDistributeVerbatim

      void setDistributeVerbatim(boolean distributeVerbatim)
      Sets the distribution rights.
      Parameters:
      distributeVerbatim - right to distribute verbatim copies
      Throws:
      InvalidArgumentException - distributeVerbatim is invalid
      NoAccessException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • clearDistributeVerbatim

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

    • getDistributeAlterationsMetadata

      Metadata getDistributeAlterationsMetadata()
      Gets the metadata for the distribute alterations rights flag.
      Returns:
      metadata for the distribution rights fields
      Compliance:
      mandatory - This method must be implemented.

    • setDistributeAlterations

      void setDistributeAlterations(boolean distributeMods)
      Sets the distribute alterations flag. This also sets distribute verbatim to true.
      Parameters:
      distributeMods - right to distribute modifications
      Throws:
      InvalidArgumentException - distributeMods is invalid
      NoAccessException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • clearDistributeAlterations

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

    • getDistributeCompositionsMetadata

      Metadata getDistributeCompositionsMetadata()
      Gets the metadata for the distribute compositions rights flag.
      Returns:
      metadata for the distribution rights fields
      Compliance:
      mandatory - This method must be implemented.

    • setDistributeCompositions

      void setDistributeCompositions(boolean distributeComps)
      Sets the distribution rights. This sets distribute verbatim to true.
      Parameters:
      distributeComps - right to distribute modifications
      Throws:
      InvalidArgumentException - distributeComps is invalid
      NoAccessException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • clearDistributeCompositions

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

    • getSourceMetadata

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

    • setSource

      void setSource(Id sourceId)
      Sets the source.
      Parameters:
      sourceId - the new publisher
      Throws:
      InvalidArgumentException - sourceId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - sourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSource

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

    • getProviderLinksMetadata

      Metadata getProviderLinksMetadata()
      Gets the metadata for the provider chain.
      Returns:
      metadata for the provider chain
      Compliance:
      mandatory - This method must be implemented.

    • setProviderLinks

      void setProviderLinks(Id[] resourceIds)
      Sets a provider chain in order from the most recent source to the originating source.
      Parameters:
      resourceIds - the new source
      Throws:
      InvalidArgumentException - resourceIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - resourceIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProviderLinks

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

    • getCreatedDateMetadata

      Metadata getCreatedDateMetadata()
      Gets the metadata for the asset creation date.
      Returns:
      metadata for the created date
      Compliance:
      mandatory - This method must be implemented.

    • setCreatedDate

      void setCreatedDate(DateTime createdDate)
      Sets the created date.
      Parameters:
      createdDate - the new created date
      Throws:
      InvalidArgumentException - createdDate is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - createdDate is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCreatedDate

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

    • getPublishedMetadata

      Metadata getPublishedMetadata()
      Gets the metadata for the published status.
      Returns:
      metadata for the published field
      Compliance:
      mandatory - This method must be implemented.

    • setPublished

      void setPublished(boolean published)
      Sets the published status.
      Parameters:
      published - the published status
      Throws:
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearPublished

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

    • getPublishedDateMetadata

      Metadata getPublishedDateMetadata()
      Gets the metadata for the published date.
      Returns:
      metadata for the published date
      Compliance:
      mandatory - This method must be implemented.

    • setPublishedDate

      void setPublishedDate(DateTime publishedDate)
      Sets the published date.
      Parameters:
      publishedDate - the new published date
      Throws:
      InvalidArgumentException - publishedDate is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - publishedDate is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPublishedDate

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

    • getPrincipalCreditStringMetadata

      Metadata getPrincipalCreditStringMetadata()
      Gets the metadata for the principal credit display text.
      Returns:
      metadata for the credits
      Compliance:
      mandatory - This method must be implemented.

    • setPrincipalCreditString

      void setPrincipalCreditString(String credits)
      Sets the principal credits display text.
      Parameters:
      credits - the new credits
      Throws:
      InvalidArgumentException - credits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - credits is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPrincipalCreditString

      void clearPrincipalCreditString()
      Removes the principal credit text.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCompositionMetadata

      Metadata getCompositionMetadata()
      Gets the metadata for linking this asset to a composition.
      Returns:
      metadata for the composition
      Compliance:
      mandatory - This method must be implemented.

    • setComposition

      void setComposition(Id compositionId)
      Sets the composition.
      Parameters:
      compositionId - a composition
      Throws:
      InvalidArgumentException - compositionId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - compositionId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearComposition

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

    • getAssetFormRecord

      AssetFormRecord getAssetFormRecord(Type assetRecordType) throws OperationFailedException
      Gets the AssetFormRecord corresponding to the given Asset record Type.
      Parameters:
      assetRecordType - an asset record type
      Returns:
      the asset form record
      Throws:
      NullArgumentException - assetRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(assetRecordType) is false
      Compliance:
      mandatory - This method must be implemented.