Interface DocetCourseCatalogAssignmentSession

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

This session provides methods to re-assign Docets to CourseCatalogs . A Docet may map to multiple CourseCatalogs and removing the last reference to a Docet is the equivalent of deleting it. Each CourseCatalog may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Docet to another CourseCatalog is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignDocets

      boolean canAssignDocets()
      Tests if this user can alter docet/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignDocetsToCourseCatalog

      boolean canAssignDocetsToCourseCatalog(Id courseCatalogId)
      Tests if this user can alter docet/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - courseCatalogId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableCourseCatalogIds

      IdList getAssignableCourseCatalogIds(Id courseCatalogId) throws OperationFailedException
      Gets a list of course catalogs including and under the given course catalog node in which any docet can be assigned.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      list of assignable course catalog Ids
      Throws:
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableCourseCatalogIdsForDocet

      IdList getAssignableCourseCatalogIdsForDocet(Id courseCatalogId, Id docetId) throws OperationFailedException
      Gets a list of course catalogs including and under the given course catalog node in which a specific docet can be assigned.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      docetId - the Id of the Docet
      Returns:
      list of assignable course catalog Ids
      Throws:
      NullArgumentException - courseCatalogId or docetId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignDocetToCourseCatalog

      void assignDocetToCourseCatalog(Id docetId, Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing Docet to an CourseCatalog .
      Parameters:
      docetId - the Id of the Docet
      courseCatalogId - the Id of the CourseCatalog
      Throws:
      NotFoundException - docetId or courseCatalogId not found
      NullArgumentException - docetId or courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignDocetFromCourseCatalog

      void unassignDocetFromCourseCatalog(Id docetId, Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a Docet from an CourseCatalog .
      Parameters:
      docetId - the Id of the Docet
      courseCatalogId - the Id of the CourseCatalog
      Throws:
      NotFoundException - docetId or courseCatalogId not found
      NullArgumentException - docetId or courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignDocetToCourseCatalog

      void reassignDocetToCourseCatalog(Id docetId, Id fromCourseCatalogId, Id toCourseCatalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a Docet from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.
      Parameters:
      docetId - the Id of the Docet
      fromCourseCatalogId - the Id of the current CourseCatalog
      toCourseCatalogId - the Id of the destination CourseCatalog
      Throws:
      AlreadyExistsException - docetId already assigned to toCourseCatalogId
      NotFoundException - docetId, fromCourseCatalogId , or toCourseCatalogId not found or docetId not mapped to fromCourseCatalogId
      NullArgumentException - docetId, fromCourseCatalogId , or toCourseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.