Interface RegistrationRequestManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, RegistrationRequestProfile, Sourceable
public interface RegistrationRequestManager extends OsidManager, RegistrationRequestProfile

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

  • RegistrationRequestLookupSe ssion: a session to retrieve registration requests
  • RegistrationRequestQuerySe ssion: a session to query for registration requests
  • RegistrationRequestSearchSe ssion: a session to search for registration requests
  • RegistrationRequestAdminSe ssion: a session to create and delete registration requests
  • RegistrationRequestNotificationSe ssion: a session to receive notifications pertaining to registration request changes
  • RegistrationRequestCourseCatalogSe ssion: a session to look up registration request course catalog mappings
  • RegistrationRequestCourseCatalogAssignmentSe ssion: a session to manage registration request to course catalog mappings
  • RegistrationRequestSmartCourseCatalogSession : a session to manage dynamic course catalogs of registration requests
  • RegistrationRequestItemLook upSession: a session to retrieve registration request items
  • RegistrationRequestItemQue rySession: a session to query for registration request items
  • RegistrationRequestItemSear chSession: a session to search for registration request items
  • RegistrationRequestItemAdm inSession: a session to create and delete registration request items
  • RegistrationRequestItemNotificati onSession: a session to receive notifications pertaining to registration request item changes
  • RegistrationRequestItemCourseCatal ogSession: a session to look up registration request item course catalog mappings
  • RegistrationRequestItemCourseCatalogAssignme ntSession: a session to manage registration request item to course catalog mappings
  • RegistrationRequestItemSmartCourseCatalogSes sion: a session to manage dynamic course catalogs of registration request items

  • Method Details

    • getRegistrationRequestLookupSession

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

    • getRegistrationRequestLookupSessionForCourseCatalog

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

    • getRegistrationRequestQuerySession

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

    • getRegistrationRequestQuerySessionForCourseCatalog

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

    • getRegistrationRequestSearchSession

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

    • getRegistrationRequestSearchSessionForCourseCatalog

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

    • getRegistrationRequestAdminSession

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

    • getRegistrationRequestAdminSessionForCourseCatalog

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

    • getRegistrationRequestNotificationSession

      RegistrationRequestNotificationSession getRegistrationRequestNotificationSession(RegistrationRequestReceiver registrationRequestReceiver) throws OperationFailedException
      Gets the OsidSession associated with the registration request notification service.
      Parameters:
      registrationRequestReceiver - the notification callback
      Returns:
      a RegistrationRequestNotificationSession
      Throws:
      NullArgumentException - registrationRequestReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationRequestNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationRequestNotification()} is {@code true} .

    • getRegistrationRequestNotificationSessionForCourseCatalog

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

    • getRegistrationRequestCourseCatalogSession

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

    • getRegistrationRequestCourseCatalogAssignmentSession

      RegistrationRequestCourseCatalogAssignmentSession getRegistrationRequestCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning registration requests to course catalogs.
      Returns:
      a RegistrationRequestCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationRequestCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationRequestCourseCatalogAssignment()} is {@code true} .

    • getRegistrationRequestSmartCourseCatalogSession

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

    • getRegistrationRequestItemLookupSession

      RegistrationRequestItemLookupSession getRegistrationRequestItemLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the registration request item lookup service.
      Returns:
      a RegistrationRequestItemLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationRequestItemLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationRequestItemLookup()} is {@code true} .

    • getRegistrationRequestItemLookupSessionForCourseCatalog

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

    • getRegistrationRequestItemQuerySession

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

    • getRegistrationRequestItemQuerySessionForCourseCatalog

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

    • getRegistrationRequestItemSearchSession

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

    • getRegistrationRequestItemSearchSessionForCourseCatalog

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

    • getRegistrationRequestItemAdminSession

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

    • getRegistrationRequestItemAdminSessionForCourseCatalog

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

    • getRegistrationRequestItemNotificationSession

      RegistrationRequestItemNotificationSession getRegistrationRequestItemNotificationSession(RegistrationRequestItemReceiver registrationRequestItemReceiver) throws OperationFailedException
      Gets the OsidSession associated with the registration request item notification service.
      Parameters:
      registrationRequestItemReceiver - the notification callback
      Returns:
      a RegistrationRequestItemNotificationSession
      Throws:
      NullArgumentException - registrationRequestItemReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationRequestItemNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationRequestItemNotification()} is {@code true} .

    • getRegistrationRequestItemNotificationSessionForCourseCatalog

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

    • getRegistrationRequestItemCourseCatalogSession

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

    • getRegistrationRequestItemCourseCatalogAssignmentSession

      RegistrationRequestItemCourseCatalogAssignmentSession getRegistrationRequestItemCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning registration request items to course catalogs.
      Returns:
      a RegistrationRequestItemCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationRequestItemCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationRequestItemCourseCatalogAssignment()} is {@code true} .

    • getRegistrationRequestItemSmartCourseCatalogSession

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