Interface RequisiteCourseCatalogAssignmentSession

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

This session provides methods to re-assign Requisites to CourseCatalogs . A Requisite may appear in multiple CourseCatalogs and removing the last reference to a Requisite 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 Requisite to another CourseCatalog is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignRequisites

      boolean canAssignRequisites()
      Tests if this user can alter requisite/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.

    • canAssignRequisiteToCourseCatalog

      boolean canAssignRequisiteToCourseCatalog(Id courseCatalogId)
      Tests if this user can alter requisite/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 lookup 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 requisite 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.

    • getAssignableCourseCatalogIdsForRequisite

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

    • assignRequisiteToCourseCatalog

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

    • unassignRequisiteFromCourseCatalog

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

    • reassignCreditToCourseCatalog

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