Interface RegistrationRequestItemCourseCatalogAssignmentSession

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

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

  • Method Details

    • canAssignRegistrationRequestItems

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

    • canAssignRegistrationRequestItemToCourseCatalog

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

    • getAssignableCourseCatalogIdsForRegistrationRequestItem

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

    • assignRegistrationRequestItemToCourseCatalog

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

    • unassignRegistrationRequestItemFromCourseCatalog

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

    • reassignRegistrationRequestItemToCourseCatalog

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