Interface ActivityCourseCatalogSession

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

This session provides methods to retrieve Activity to CourseCatalog mappings. An Activity may appear in multiple CourseCatalog objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupActivityCourseCatalogMappings

      boolean canLookupActivityCourseCatalogMappings()
      Tests if this user can perform lookups of activity/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeActivityCourseCatalogView

      void useComparativeActivityCourseCatalogView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryActivityCourseCatalogView

      void usePlenaryActivityCourseCatalogView()
      A complete view of the Activity and CourseCatalog returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getActivityIdsByCourseCatalog

      IdList getActivityIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of Activity Ids associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related activity Ids
      Throws:
      NotFoundException - courseCatalogId is not found
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitieByCourseCatalog

      ActivityList getActivitieByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of Activity associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related activities
      Throws:
      NotFoundException - courseCatalogId is not found
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivityIdsByCourseCatalogs

      IdList getActivityIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of Activity Ids corresponding to a list of CourseCatalog objects.
      Parameters:
      courseCatalogIds - list of catalog Ids
      Returns:
      list of activity Ids
      Throws:
      NullArgumentException - courseCatalogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitieByCourseCatalogs

      ActivityList getActivitieByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of Activities corresponding to a list of CourseCatalog objects.
      Parameters:
      courseCatalogIds - list of catalog Ids
      Returns:
      list of activities
      Throws:
      NullArgumentException - courseCatalogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogIdsByActivity

      IdList getCourseCatalogIdsByActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog Ids mapped to an Activity .
      Parameters:
      activityId - Id of an Activity
      Returns:
      list of course catalogs
      Throws:
      NotFoundException - activityId is not found
      NullArgumentException - activityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogsByActivity

      CourseCatalogList getCourseCatalogsByActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog objects mapped to an Activity .
      Parameters:
      activityId - Id of an Activity
      Returns:
      list of course catalogs
      Throws:
      NotFoundException - activityId is not found
      NullArgumentException - activityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.