Interface CourseRegistrationManager

All Superinterfaces:
AutoCloseable, Closeable, CourseRegistrationProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface CourseRegistrationManager extends OsidManager, CourseRegistrationProfile

The course registration manager provides access to registration sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • RegistrationTargetLookupSes sion: a session to retrieve registration targets
  • RegistrationTargetQuerySes sion: a session to query for registration targets
  • RegistrationTargetSearchSes sion: a session to search for registration targets
  • RegistrationTargetAdminSes sion: a session to create and delete registration targets
  • RegistrationTargetNotificationSes sion: a session to receive notifications pertaining to registration target changes
  • RegistrationTargetCourseCatalogSes sion: a session to look up registration target course catalog mappings
  • RegistrationTargetCourseCatalogAssignmentSes sion: a session to manage registration target to course catalog mappings
  • RegistrationTargetSmartCourseCatalogSession : a session to manage dynamic course catalogs of registration targets
  • RegistrationLookupSession : a session to retrieve registrations
  • RegistrationQuerySession : a session to query registrations
  • RegistrationSearchSession : a session to search for registrations
  • RegistrationAdminSession : a session to create and delete registrations
  • RegistrationNotificationSession : a session to receive notifications pertaining to registration changes
  • RegistrationCourseCatalogSession : a session to look up registration to course catalog mappings
  • RegistrationCourseCatalogAssignmentSession : a session to manage registration to course catalog mappings
  • RegistrationSmartCourseCatalogSession : a session to manage dynamic course catalogs of registrations
  • CourseRegistrationLookupSes sion: a session to retrieve course registrations
  • CourseRegistrationQuerySes sion: a session to query for course registrations
  • CourseRegistrationSearchSes sion: a session to search for course registrations
  • CourseRegistrationAdminSes sion: a session to create and delete course registrations
  • CourseRegistrationNotificationSes sion: a session to receive notifications pertaining to course registration changes
  • CourseRegistrationCourseCatalogSes sion: a session to look up course registration course catalog mappings
  • CourseRegistrationCourseCatalogAssignmentSes sion: a session to manage course registration to course catalog mappings
  • CourseRegistrationSmartCourseCatalogSession : a session to manage dynamic course catalogs of course registrations
  • ActivityRegistrationLookupSession : a session to retrieve activity registrations
  • ActivityRegistrationQuerySession : a session to query activity registrations
  • ActivityRegistrationSearchSession : a session to search for activity registrations
  • ActivityRegistrationAdminSession : a session to create and delete activity registrations
  • ActivityRegistrationNotificationSession : a session to receive notifications pertaining to activity registration changes
  • ActivityRegistrationCourseCatalogSession : a session to look up activity registration to course catalog mappings
  • ActivityRegistrationCourseCatalogAssignmentSession : a session to manage activity registration to course catalog mappings
  • ActivityRegistrationSmartCourseCatalogSession : a session to manage dynamic course catalogs of activity registrations
  • Method Details

    • getRegistrationTargetLookupSession

      RegistrationTargetLookupSession getRegistrationTargetLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the registration target lookup service.
      Returns:
      a RegistrationTargetLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetLookup()} is {@code true} .
    • getRegistrationTargetLookupSessionForCourseCatalog

      RegistrationTargetLookupSession getRegistrationTargetLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration target lookup service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationTargetLookupSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationTargetQuerySession

      RegistrationTargetQuerySession getRegistrationTargetQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the registration target query service.
      Returns:
      a RegistrationTargetQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetQuery()} is {@code true} .
    • getRegistrationTargetQuerySessionForCourseCatalog

      RegistrationTargetQuerySession getRegistrationTargetQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration target query service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationTargetQuerySession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationTargetSearchSession

      RegistrationTargetSearchSession getRegistrationTargetSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the registration target search service.
      Returns:
      a RegistrationTargetSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetSearch()} is {@code true} .
    • getRegistrationTargetSearchSessionForCourseCatalog

      RegistrationTargetSearchSession getRegistrationTargetSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration target search service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationTargetSearchSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationTargetAdminSession

      RegistrationTargetAdminSession getRegistrationTargetAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the registration target administration service.
      Returns:
      a RegistrationTargetAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetAdmin()} is {@code true} .
    • getRegistrationTargetAdminSessionForCourseCatalog

      RegistrationTargetAdminSession getRegistrationTargetAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration target administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationTargetAdminSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationTargetNotificationSession

      RegistrationTargetNotificationSession getRegistrationTargetNotificationSession(RegistrationTargetReceiver registrationTargetReceiver) throws OperationFailedException
      Gets the OsidSession associated with the registration target notification service.
      Parameters:
      registrationTargetReceiver - the notification callback
      Returns:
      a RegistrationTargetNotificationSession
      Throws:
      NullArgumentException - registrationTargetReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetNotification()} is {@code true} .
    • getRegistrationTargetNotificationSessionForCourseCatalog

      RegistrationTargetNotificationSession getRegistrationTargetNotificationSessionForCourseCatalog(RegistrationTargetReceiver registrationTargetReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration target notification service for the given course catalog.
      Parameters:
      registrationTargetReceiver - the notification callback
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationTargetNotificationSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - registrationTargetReceiver or courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationTargetCourseCatalogSession

      RegistrationTargetCourseCatalogSession getRegistrationTargetCourseCatalogSession() throws OperationFailedException
      Gets the OsidSession to lookup registration target/course catalog mappings.
      Returns:
      a RegistrationTargetCourseCatalogSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetCourseCatalog()} is {@code true} .
    • getRegistrationTargetCourseCatalogAssignmentSession

      RegistrationTargetCourseCatalogAssignmentSession getRegistrationTargetCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning registration targets to course catalogs.
      Returns:
      a RegistrationTargetCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetCourseCatalogAssignment()} is {@code true} .
    • getRegistrationTargetSmartCourseCatalogSession

      RegistrationTargetSmartCourseCatalogSession getRegistrationTargetSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage registration target smart course catalogs.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationTargetSmartCourseCatalogSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetSmartCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetSmartCourseCatalog()} is {@code true} .
    • getRegistrationLookupSession

      RegistrationLookupSession getRegistrationLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the registration lookup service.
      Returns:
      a RegistrationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationLookup()} is {@code true} .
    • getRegistrationLookupSessionForCourseCatalog

      RegistrationLookupSession getRegistrationLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration lookup service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the course catalog
      Returns:
      a RegistrationLookupSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationQuerySession

      RegistrationQuerySession getRegistrationQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the registration query service.
      Returns:
      a RegistrationQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationQuery()} is {@code true} .
    • getRegistrationQuerySessionForCourseCatalog

      RegistrationQuerySession getRegistrationQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration query service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationQuerySession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationSearchSession

      RegistrationSearchSession getRegistrationSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the registration search service.
      Returns:
      a RegistrationSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationSearch()} is {@code true} .
    • getRegistrationSearchSessionForCourseCatalog

      RegistrationSearchSession getRegistrationSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration search service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationSearchSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationAdminSession

      RegistrationAdminSession getRegistrationAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the registration administration service.
      Returns:
      a RegistrationAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationAdmin()} is {@code true} .
    • getRegistrationAdminSessionForCourseCatalog

      RegistrationAdminSession getRegistrationAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationAdminSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationNotificationSession

      RegistrationNotificationSession getRegistrationNotificationSession(RegistrationReceiver registrationReceiver) throws OperationFailedException
      Gets the OsidSession associated with the registration notification service.
      Parameters:
      registrationReceiver - the notification callback
      Returns:
      a RegistrationNotificationSession
      Throws:
      NullArgumentException - registrationReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationNotification()} is {@code true} .
    • getRegistrationNotificationSessionForCourseCatalog

      RegistrationNotificationSession getRegistrationNotificationSessionForCourseCatalog(RegistrationReceiver registrationReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration notification service for the given course catalog.
      Parameters:
      registrationReceiver - the notification callback
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationNotificationSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - registrationReceiver or courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getRegistrationCourseCatalogSession

      RegistrationCourseCatalogSession getRegistrationCourseCatalogSession() throws OperationFailedException
      Gets the OsidSession to lookup registration/catalog mappings.
      Returns:
      a RegistrationCourseCatalogSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationCourseCatalog()} is {@code true} .
    • getRegistrationCourseCatalogAssignmentSession

      RegistrationCourseCatalogAssignmentSession getRegistrationCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning registrations to course catalogs.
      Returns:
      a RegistrationCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationCourseCatalogAssignment()} is {@code true} .
    • getRegistrationSmartCourseCatalogSession

      RegistrationSmartCourseCatalogSession getRegistrationSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the registration smart course catalog service.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a RegistrationSmartCourseCatalogSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationSmartCourseCatalog() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true} .
    • getCourseRegistrationLookupSession

      CourseRegistrationLookupSession getCourseRegistrationLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the course registration lookup service.
      Returns:
      a CourseRegistrationLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationLookup()} is {@code true} .
    • getCourseRegistrationLookupSessionForCourseCatalog

      CourseRegistrationLookupSession getCourseRegistrationLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the course registration lookup service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a CourseRegistrationLookupSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getCourseRegistrationQuerySession

      CourseRegistrationQuerySession getCourseRegistrationQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the course registration query service.
      Returns:
      a CourseRegistrationQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationQuery()} is {@code true} .
    • getCourseRegistrationQuerySessionForCourseCatalog

      CourseRegistrationQuerySession getCourseRegistrationQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the course registration query service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a CourseRegistrationQuerySession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getCourseRegistrationSearchSession

      CourseRegistrationSearchSession getCourseRegistrationSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the course registration search service.
      Returns:
      a CourseRegistrationSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationSearch()} is {@code true} .
    • getCourseRegistrationSearchSessionForCourseCatalog

      CourseRegistrationSearchSession getCourseRegistrationSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the course registration search service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a CourseRegistrationSearchSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getCourseRegistrationAdminSession

      CourseRegistrationAdminSession getCourseRegistrationAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the course registration administration service.
      Returns:
      a CourseRegistrationAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationAdmin()} is {@code true} .
    • getCourseRegistrationAdminSessionForCourseCatalog

      CourseRegistrationAdminSession getCourseRegistrationAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the course registration administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a CourseRegistrationAdminSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getCourseRegistrationNotificationSession

      CourseRegistrationNotificationSession getCourseRegistrationNotificationSession(CourseRegistrationReceiver courseRegistrationReceiver) throws OperationFailedException
      Gets the OsidSession associated with the course registration notification service.
      Parameters:
      courseRegistrationReceiver - the notification callback
      Returns:
      a CourseRegistrationNotificationSession
      Throws:
      NullArgumentException - courseRegistrationReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationNotification()} is {@code true} .
    • getCourseRegistrationNotificationSessionForCourseCatalog

      CourseRegistrationNotificationSession getCourseRegistrationNotificationSessionForCourseCatalog(CourseRegistrationReceiver courseRegistrationReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the course registration notification service for the given course catalog.
      Parameters:
      courseRegistrationReceiver - the notification callback
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a CourseRegistrationNotificationSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseRegistrationReceiver or courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getCourseRegistrationCourseCatalogSession

      CourseRegistrationCourseCatalogSession getCourseRegistrationCourseCatalogSession() throws OperationFailedException
      Gets the OsidSession to lookup course registration/course catalog mappings.
      Returns:
      a CourseRegistrationCourseCatalogSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationCourseCatalog()} is {@code true} .
    • getCourseRegistrationCourseCatalogAssignmentSession

      CourseRegistrationCourseCatalogAssignmentSession getCourseRegistrationCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning course registrations to course catalogs.
      Returns:
      a CourseRegistrationCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationCourseCatalogAssignment()} is {@code true} .
    • getCourseRegistrationSmartCourseCatalogSession

      CourseRegistrationSmartCourseCatalogSession getCourseRegistrationSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage course registration smart course catalogs.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a CourseRegistrationSmartCourseCatalogSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationSmartCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseRegistrationSmartCourseCatalog()} is {@code true} .
    • getActivityRegistrationLookupSession

      ActivityRegistrationLookupSession getActivityRegistrationLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the activity registration lookup service.
      Returns:
      an ActivityRegistrationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationLookup()} is {@code true} .
    • getActivityRegistrationLookupSessionForCourseCatalog

      ActivityRegistrationLookupSession getActivityRegistrationLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the activity registration lookup service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the course catalog
      Returns:
      an ActivityRegistrationLookupSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getActivityRegistrationQuerySession

      ActivityRegistrationQuerySession getActivityRegistrationQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the activity registration query service.
      Returns:
      an ActivityRegistrationQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationQuery()} is {@code true} .
    • getActivityRegistrationQuerySessionForCourseCatalog

      ActivityRegistrationQuerySession getActivityRegistrationQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the activity registration query service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      an ActivityRegistrationQuerySession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getActivityRegistrationSearchSession

      ActivityRegistrationSearchSession getActivityRegistrationSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the activity registration search service.
      Returns:
      an ActivityRegistrationSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationSearch()} is {@code true} .
    • getActivityRegistrationSearchSessionForCourseCatalog

      ActivityRegistrationSearchSession getActivityRegistrationSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the activity registration search service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      an ActivityRegistrationSearchSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getActivityRegistrationAdminSession

      ActivityRegistrationAdminSession getActivityRegistrationAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the activity registration administration service.
      Returns:
      an ActivityRegistrationAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationAdmin()} is {@code true} .
    • getActivityRegistrationAdminSessionForCourseCatalog

      ActivityRegistrationAdminSession getActivityRegistrationAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the activity registration administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      an ActivityRegistrationAdminSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getActivityRegistrationNotificationSession

      ActivityRegistrationNotificationSession getActivityRegistrationNotificationSession(ActivityRegistrationReceiver activityRegistrationReceiver) throws OperationFailedException
      Gets the OsidSession associated with the activity registration notification service.
      Parameters:
      activityRegistrationReceiver - the notification callback
      Returns:
      an ActivityRegistrationNotificationSession
      Throws:
      NullArgumentException - activityRegistrationReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationNotification()} is {@code true} .
    • getActivityRegistrationNotificationSessionForCourseCatalog

      ActivityRegistrationNotificationSession getActivityRegistrationNotificationSessionForCourseCatalog(ActivityRegistrationReceiver activityRegistrationReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the activity registration notification service for the given course catalog.
      Parameters:
      activityRegistrationReceiver - the notification callback
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      an ActivityRegistrationNotificationSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - activityRegistrationReceiver or courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getActivityRegistrationCourseCatalogSession

      ActivityRegistrationCourseCatalogSession getActivityRegistrationCourseCatalogSession() throws OperationFailedException
      Gets the OsidSession to lookup activity registration/catalog mappings.
      Returns:
      an ActivityRegistrationCourseCatalogSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationCourseCatalog()} is {@code true} .
    • getActivityRegistrationCourseCatalogAssignmentSession

      ActivityRegistrationCourseCatalogAssignmentSession getActivityRegistrationCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning activity registrations to course catalogs.
      Returns:
      an ActivityRegistrationCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationCourseCatalogAssignment()} is {@code true} .
    • getActivityRegistrationSmartCourseCatalogSession

      ActivityRegistrationSmartCourseCatalogSession getActivityRegistrationSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the activity registration smart course catalog service.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      an ActivityRegistrationSmartCourseCatalogSession
      Throws:
      NotFoundException - no course catalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityRegistrationSmartCourseCatalog() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityRegistrationSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true} .
    • getCourseRegistrationBatchManager

      CourseRegistrationBatchManager getCourseRegistrationBatchManager() throws OperationFailedException
      Gets a CourseRegistrationBatchManager .
      Returns:
      a CourseRegistrationBatchManager
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseRegistrationBatch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsACourseRegistrationBatch()} is {@code true} .
    • getRegistrationRequestManager

      RegistrationRequestManager getRegistrationRequestManager() throws OperationFailedException
      Gets a RegistrationRequestManager .
      Returns:
      a RegistrationRequestManager
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationRequest() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationRequest()} is {@code true} .