Interface AssetContentRepositorySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AssetContentRepositorySession extends OsidSession

This session provides methods to retrieve AssetContent to Repository mappings. An AssetContent may appear in multiple Repository object s. Each repository may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupAssetContentRepositoryMappings

      boolean canLookupAssetContentRepositoryMappings()
      Tests if this user can perform lookups of asset content/repository mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAssetContentRepositoryView

      void useComparativeAssetContentRepositoryView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryAssetContentRepositoryView

      void usePlenaryAssetContentRepositoryView()
      A complete view of the AssetContent and Repository returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getAssetContentIdsByRepository

      IdList getAssetContentIdsByRepository(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of AssetContent Ids associated with a Repository .
      Parameters:
      repositoryId - Id of the Repository
      Returns:
      list of related asset content Ids
      Throws:
      NotFoundException - repositoryId is not found
      NullArgumentException - repositoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssetContentsByRepository

      AssetContentList getAssetContentsByRepository(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of AssetContents associated with a Repository .
      Parameters:
      repositoryId - Id of the Repository
      Returns:
      list of related asset contents
      Throws:
      NotFoundException - repositoryId is not found
      NullArgumentException - repositoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssetContentIdsByRepositories

      IdList getAssetContentIdsByRepositories(IdList repositoryIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of AssetContent Ids corresponding to a list of Repositories .
      Parameters:
      repositoryIds - list of repository Ids
      Returns:
      list of asset content Ids
      Throws:
      NullArgumentException - repositoryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssetContentsByRepositories

      AssetContentList getAssetContentsByRepositories(IdList repositoryIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of AssetContent corresponding to a list of Repositories .
      Parameters:
      repositoryIds - list of repository Ids
      Returns:
      list of asset contents
      Throws:
      NullArgumentException - repositoryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRepositoryIdsByAssetContent

      IdList getRepositoryIdsByAssetContent(Id assetContentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Repository Ids mapped to an AssetContent .
      Parameters:
      assetContentId - Id of an AssetContent
      Returns:
      list of repository Ids
      Throws:
      NotFoundException - assetContentId is not found
      NullArgumentException - assetContentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRepositoriesByAssetContent

      RepositoryList getRepositoriesByAssetContent(Id assetContentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Repositories mapped to an AssetContent .
      Parameters:
      assetContentId - Id of an AssetContent
      Returns:
      list of repositories
      Throws:
      NotFoundException - assetContentId is not found
      NullArgumentException - assetContentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.