Interface ActivityRegistrationCourseCatalogSession

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

This session provides methods to retrieve ActivityRegistration to CourseCatalog mappings. An ActivityRegistration 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

    • canLookupActivityRegistrationCourseCatalogMappings

      boolean canLookupActivityRegistrationCourseCatalogMappings()
      Tests if this user can perform lookups of activity registration/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.

    • useComparativeActivityRegistrationCourseCatalogView

      void useComparativeActivityRegistrationCourseCatalogView()
      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.

    • usePlenaryActivityRegistrationCourseCatalogView

      void usePlenaryActivityRegistrationCourseCatalogView()
      A complete view of the ActivityRegistration 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.

    • getActivityRegistrationIdsByCourseCatalog

      IdList getActivityRegistrationIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ActivityRegistrationIds associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related activity registration 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.

    • getActivityRegistrationsByCourseCatalog

      ActivityRegistrationList getActivityRegistrationsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ActivityRegistrations associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related activity registrations
      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.

    • getActivityRegistrationIdsByCourseCatalogs

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

    • getActivityRegistrationsByCourseCatalogs

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

    • getCourseCatalogIdsByActivityRegistration

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

    • getCourseCatalogsByActivityRegistration

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