Interface AwardEntryCourseCatalogAssignmentSession

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

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

  • Method Details

    • canAssignAwardEntries

      boolean canAssignAwardEntries()
      Tests if this user can alter award entry/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.

    • canAssignAwardEntryToCourseCatalog

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

    • getAssignableCourseCatalogIdsForAwardEntry

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

    • assignAwardEntryToCourseCatalog

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

    • unassignAwardEntryFromCourseCatalog

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

    • reassignAwardEntryToCourseCatalog

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