Interface CourseProgramManager

All Superinterfaces:
AutoCloseable, Closeable, CourseProgramProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CourseProgramManager extends OsidManager, CourseProgramProfile

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

  • ProgramLookupSession : a session to retrieve programs
  • ProgramQuerySession : a session to query programs
  • ProgramSearchSession : a session to search for programs
  • ProgramAdminSession : a session to create and delete programs
  • ProgramNotificationSession : a session to receive notifications pertaining to program changes
  • ProgramCourseCatalogSession : a session to look up program to course catalog mappings
  • ProgramCourseCatalogAssignmentSession : a session to manage program to course catalog mappings
  • ProgramSmartCourseCatalogSession : a session to manage dynamic course catalogs of programs
  • CourseProgramLookupSession : a session to look up course to program mappings
  • CourseProgramAssignmentSession : a session to manage course to program mappings
  • ProgramOfferingLookupSession : a session to retrieve program offerings
  • ProgramOfferingQuerySession : a session to query program offerings
  • ProgramOfferingSearchSession : a session to search for program offerings
  • ProgramOfferingAdminSession : a session to create and delete program offerings
  • ProgramOfferingNotificationSession : a session to receive notifications pertaining to program offering changes
  • ProgramOfferingCourseCatalogSession : a session to look up program offering to course catalog mappings
  • ProgramOfferingCourseCatalogAssignmentSession : a session to manage program offering to course catalog mappings
  • ProgramOfferingSmartCourseCatalogSession : a session to manage dynamic course catalogs of program offerings
  • CredentialLookupSession : a session to retrieve credentials
  • CredentialQuerySession : a session to query credentials
  • CredentialSearchSession : a session to search for credentials
  • CredentialAdminSession : a session to create and delete credentials
  • CredentialNotificationSession : a session to receive notifications pertaining to credential changes
  • CredentialCourseCatalogSession : a session to look up credential to course catalog mappings
  • CredentialCourseCatalogAssignmentSession : a session to manage credential to course catalog mappings
  • CredentialSmartCourseCatalogSession : a session to manage dynamic course catalogs of credentials
  • EnrollmentLookupSession : a session to retrieve enrollments
  • EnrollmentQuerySession : a session to query enrollments
  • EnrollmentSearchSession : a session to search for enrollments
  • EnrollmentAdminSession : a session to create and delete enrollments
  • EnrollmentNotificationSession : a session to receive notifications pertaining to enrollment changes
  • EnrollmentCourseCatalogSession : a session to look up enrollment to course catalog mappings
  • EnrollmentCourseCatalogAssignmentSession : a session to manage enrollment to course catalog mappings
  • EnrollmentSmartCourseCatalogSession : a session to manage dynamic course catalogs of enrollments

  • Method Details

    • getProgramLookupSession

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

    • getProgramLookupSessionForCourseCatalog

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

    • getProgramQuerySession

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

    • getProgramQuerySessionForCourseCatalog

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

    • getProgramSearchSession

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

    • getProgramSearchSessionForCourseCatalog

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

    • getProgramAdminSession

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

    • getProgramAdminSessionForCourseCatalog

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

    • getProgramNotificationSession

      ProgramNotificationSession getProgramNotificationSession(ProgramReceiver programReceiver) throws OperationFailedException
      Gets the OsidSession associated with the program notification service.
      Parameters:
      programReceiver - the notification callback
      Returns:
      a ProgramNotificationSession
      Throws:
      NullArgumentException - programReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramNotification()} is {@code true} .

    • getProgramNotificationSessionForCourseCatalog

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

    • getProgramCourseCatalogSession

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

    • getProgramCourseCatalogAssignmentSession

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

    • getProgramSmartCourseCatalogSession

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

    • getCourseProgramLookupSession

      CourseProgramLookupSession getCourseProgramLookupSession() throws OperationFailedException
      Gets the OsidSession associated with looking up course to program mappings.
      Returns:
      a CourseProgramLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseProgramLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseProgramLookup()} is {@code true} .

    • getCourseProgramLookupSessionForCourseCatalog

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

    • getCourseProgramAssignmentSession

      CourseProgramAssignmentSession getCourseProgramAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with managing course to program mappings.
      Returns:
      a CourseProgramAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseProgramAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseProgramAssignment()} is {@code true} .

    • getCourseProgramAssignmentSessionForCourseCatalog

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

    • getProgramOfferingLookupSession

      ProgramOfferingLookupSession getProgramOfferingLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the program offering lookup service.
      Returns:
      a ProgramOfferingSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingLookup()} is {@code true} .

    • getProgramOfferingLookupSessionForCourseCatalog

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

    • getProgramOfferingQuerySession

      ProgramQuerySession getProgramOfferingQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the program offering query service.
      Returns:
      a ProgramOfferingQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingQuery()} is {@code true} .

    • getProgramOfferingQuerySessionForCourseCatalog

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

    • getProgramOfferingSearchSession

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

    • getProgramOfferingSearchSessionForCourseCatalog

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

    • getProgramOfferingAdminSession

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

    • getProgramOfferingAdminSessionForCourseCatalog

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

    • getProgramOfferingNotificationSession

      ProgramOfferingNotificationSession getProgramOfferingNotificationSession(ProgramOfferingReceiver programOfferingReceiver) throws OperationFailedException
      Gets the OsidSession associated with the program offering notification service.
      Parameters:
      programOfferingReceiver - the notification callback
      Returns:
      a ProgramOfferingNotificationSession
      Throws:
      NullArgumentException - programOfferingReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingNotification()} is {@code true} .

    • getProgramOfferingNotificationSessionForCourseCatalog

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

    • getProgramOfferingCourseCatalogSession

      ProgramOfferingCourseCatalogSession getProgramOfferingCourseCatalogSession() throws OperationFailedException
      Gets the OsidSession to lookup program offering/catalog mappings.
      Returns:
      a ProgramOfferingCourseCatalogSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingCourseCatalog()} is {@code true} .

    • getProgramOfferingCourseCatalogAssignmentSession

      ProgramOfferingCourseCatalogAssignmentSession getProgramOfferingCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning program offerings to course catalogs.
      Returns:
      a ProgramOfferingCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingCourseCatalogAssignment()} is {@code true} .

    • getProgramOfferingSmartCourseCatalogSession

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

    • getCredentialLookupSession

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

    • getCredentialLookupSessionForCourseCatalog

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

    • getCredentialQuerySession

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

    • getCredentialQuerySessionForCourseCatalog

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

    • getCredentialSearchSession

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

    • getCredentialSearchSessionForCourseCatalog

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

    • getCredentialAdminSession

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

    • getCredentialAdminSessionForCourseCatalog

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

    • getCredentialNotificationSession

      CredentialNotificationSession getCredentialNotificationSession(CredentialReceiver credentialReceiver) throws OperationFailedException
      Gets the OsidSession associated with the course notification service.
      Parameters:
      credentialReceiver - the notification callback
      Returns:
      a CredentialNotificationSession
      Throws:
      NullArgumentException - credentialReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCredentialNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialNotification()} is {@code true} .

    • getCredentialNotificationSessionForCourseCatalog

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

    • getCredentialCourseCatalogSession

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

    • getCredentialCourseCatalogAssignmentSession

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

    • getCredentialSmartCourseCatalogSession

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

    • getEnrollmentLookupSession

      EnrollmentLookupSession getEnrollmentLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the enrollment lookup service.
      Returns:
      an EnrollmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentLookup()} is {@code true} .

    • getEnrollmentLookupSessionForCourseCatalog

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

    • getEnrollmentQuerySession

      EnrollmentQuerySession getEnrollmentQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the enrollment query service.
      Returns:
      an EnrollmentQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentQuery()} is {@code true} .

    • getEnrollmentQuerySessionForCourseCatalog

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

    • getEnrollmentSearchSession

      EnrollmentSearchSession getEnrollmentSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the enrollment search service.
      Returns:
      an EnrollmentSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentSearch()} is {@code true} .

    • getEnrollmentSearchSessionForCourseCatalog

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

    • getEnrollmentAdminSession

      EnrollmentAdminSession getEnrollmentAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the enrollment administration service.
      Returns:
      an EnrollmentAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentAdmin()} is {@code true} .

    • getEnrollmentAdminSessionForCourseCatalog

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

    • getEnrollmentNotificationSession

      EnrollmentNotificationSession getEnrollmentNotificationSession(EnrollmentReceiver enrollmentReceiver) throws OperationFailedException
      Gets the OsidSession associated with the enrollment notification service.
      Parameters:
      enrollmentReceiver - the notification callback
      Returns:
      an EnrollmentNotificationSession
      Throws:
      NullArgumentException - enrollmentReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentNotification()} is {@code true} .

    • getEnrollmentNotificationSessionForCourseCatalog

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

    • getEnrollmentCourseCatalogSession

      EnrollmentCourseCatalogSession getEnrollmentCourseCatalogSession() throws OperationFailedException
      Gets the OsidSession to lookup enrollment/catalog mappings.
      Returns:
      an EnrollmentCourseCatalogSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentCourseCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentCourseCatalog()} is {@code true} .

    • getEnrollmentCourseCatalogAssignmentSession

      EnrollmentCourseCatalogAssignmentSession getEnrollmentCourseCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning enrollments to course catalogs.
      Returns:
      an EnrollmentCourseCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentCourseCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentCourseCatalogAssignment()} is {@code true} .

    • getEnrollmentSmartCourseCatalogSession

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

    • getCourseProgramBatchManager

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