Interface PlanCourseCatalogAssignmentSession

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

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

  • Method Details

    • canAssignPlans

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

    • canAssignPlansToCourseCatalog

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

    • getAssignableCourseCatalogIdsForPlan

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

    • assignPlanToCourseCatalog

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

    • unassignPlanFromCourseCatalog

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

    • reassignPlanToCourseCatalog

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