Interface RegistrationRequestCourseCatalogAssignmentSession

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

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

  • Method Details

    • canAssignRegistrationRequests

      boolean canAssignRegistrationRequests()
      Tests if this user can alter registration request/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. T his 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.

    • canAssignRegistrationRequestToCourseCatalog

      boolean canAssignRegistrationRequestToCourseCatalog(Id courseCatalogId)
      Tests if this user can alter registration request/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. T his 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 registration request 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.

    • getAssignableCourseCatalogIdsForRegistrationRequest

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

    • assignRegistrationRequestToCourseCatalog

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

    • unassignRegistrationRequestFromCourseCatalog

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

    • reassignRegistrationRequestToCourseCatalog

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