Interface CourseChronicleManager

All Superinterfaces:
AutoCloseable, Closeable, CourseChronicleProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CourseChronicleManager extends OsidManager, CourseChronicleProfile

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

  • AcademicRecordSession : a session to look at a student academic record
  • ProgramEntryLookupSession : a session to retrieve program entries
  • ProgramEntryQuerySession : a session to query program entries
  • ProgramEntrySearchSession : a session to search for program entries
  • ProgramEntryAdminSession : a session to create and delete program entries
  • ProgramEntryNotificationSession : a session to receive notifications pertaining to program entry changes
  • ProgramEntryCourseCatalogSession : a session to look up program entry to course catalog mappings
  • ProgramEntryCourseCatalogAssignmentSession : a session to manage program entry to course catalog mappings
  • ProgramEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of program entries
  • CourseEntryLookupSession : a session to retrieve course entries
  • CourseEntryQuerySession : a session to query course entries
  • CourseEntrySearchSession : a session to search for course entries
  • CourseEntryAdminSession : a session to create and delete course entries
  • CourseEntryNotificationSession : a session to receive notifications pertaining to course entry changes
  • CourseEntryCourseCatalogSession : a session to look up course entry to course catalog mappings
  • CourseEntryCourseCatalogAssignmentSession : a session to manage course entry to course catalog mappings
  • CourseEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of course entries
  • CredentialEntryLookupSession : a session to retrieve credential entries
  • CredentialEntryQuerySession : a session to query credential entries
  • CredentialEntrySearchSession : a session to search for credential entries
  • CredentialEntryAdminSession : a session to create and delete credential entries
  • CredentialEntryNotificationSession : a session to receive notifications pertaining to credential entry changes
  • CredentialEntryCourseCatalogSession : a session to look up credential entry to course catalog mappings
  • CredentialEntryCourseCatalogAssignmentSession : a session to manage credential entry to course catalog mappings
  • CredentialEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of credential entries
  • AssessmentEntryLookupSession : a session to retrieve assessment entries
  • AssessmentEntryQuerySession : a session to query assessment entries
  • AssessmentEntrySearchSession : a session to search for assessment entries
  • AssessmentEntryAdminSession : a session to create and delete assessment entries
  • AssessmentEntryNotificationSession : a session to receive notifications pertaining to assessment entry changes
  • AssessmentEntryCourseCatalogSession : a session to look up assessment entry to course catalog mappings
  • AssessmentEntryCourseCatalogAssignmentSession : a session to manage assessment entry to course catalog mappings
  • AssessmentEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of assessment entries
  • AwardEntryLookupSession : a session to retrieve award entries
  • AwardEntryQuerySession : a session to query award entries
  • AwardEntrySearchSession : a session to search for award entries
  • AwardEntryAdminSession : a session to create and delete award entries
  • AwardEntryNotificationSession : a session to receive notifications pertaining to award entry changes
  • AwardEntryCourseCatalogSession : a session to look up award entry to course catalog mappings
  • AwardEntryCourseCatalogAssignmentSession : a session to manage award entry to course catalog mappings
  • AwardEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of award entries

  • Method Details

    • getAcademicRecordSession

      AcademicRecordSession getAcademicRecordSession() throws OperationFailedException
      Gets the OsidSession associated with the academic record service.
      Returns:
      an AcademicRecordSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAcademicRecord() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAcademicRecord()} is {@code true} .

    • getAcademicRecordSessionForCourseCatalog

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

    • getProgramEntryLookupSession

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

    • getProgramEntryLookupSessionForCourseCatalog

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

    • getProgramEntryQuerySession

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

    • getProgramEntryQuerySessionForCourseCatalog

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

    • getProgramEntrySearchSession

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

    • getProgramEntrySearchSessionForCourseCatalog

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

    • getProgramEntryAdminSession

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

    • getProgramEntryAdminSessionForCourseCatalog

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

    • getProgramEntryNotificationSession

      ProgramEntryNotificationSession getProgramEntryNotificationSession(ProgramEntryReceiver programEntryReceiver) throws OperationFailedException
      Gets the OsidSession associated with the program entry notification service.
      Parameters:
      programEntryReceiver - the notification callback
      Returns:
      a ProgramEntryNotificationSession
      Throws:
      NullArgumentException - programEntryReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramEntryNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramEntryNotification()} is {@code true} .

    • getProgramEntryNotificationSessionForCourseCatalog

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

    • getProgramEntryCourseCatalogSession

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

    • getProgramEntryCourseCatalogAssignmentSession

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

    • getProgramEntrySmartCourseCatalogSession

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

    • getCourseEntryLookupSession

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

    • getCourseEntryLookupSessionForCourseCatalog

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

    • getCourseEntryQuerySession

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

    • getCourseEntryQuerySessionForCourseCatalog

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

    • getCourseEntrySearchSession

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

    • getCourseEntrySearchSessionForCourseCatalog

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

    • getCourseEntryAdminSession

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

    • getCourseEntryAdminSessionForCourseCatalog

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

    • getCourseEntryNotificationSession

      CourseEntryNotificationSession getCourseEntryNotificationSession(CourseEntryReceiver courseEntryReceiver) throws OperationFailedException
      Gets the OsidSession associated with the course entry notification service.
      Parameters:
      courseEntryReceiver - the notification callback
      Returns:
      a CourseEntryNotificationSession
      Throws:
      NullArgumentException - courseEntryReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseEntryNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseEntryNotification()} is {@code true} .

    • getCourseEntryNotificationSessionForCourseCatalog

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

    • getCourseEntryCourseCatalogSession

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

    • getCourseEntryCourseCatalogAssignmentSession

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

    • getCourseEntrySmartCourseCatalogSession

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

    • getCredentialEntryLookupSession

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

    • getCredentialEntryLookupSessionForCourseCatalog

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

    • getCredentialEntryQuerySession

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

    • getCredentialEntryQuerySessionForCourseCatalog

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

    • getCredentialEntrySearchSession

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

    • getCredentialEntrySearchSessionForCourseCatalog

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

    • getCredentialEntryAdminSession

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

    • getCredentialEntryAdminSessionForCourseCatalog

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

    • getCredentialEntryNotificationSession

      CredentialEntryNotificationSession getCredentialEntryNotificationSession(CredentialEntryReceiver credentialEntryReceiver) throws OperationFailedException
      Gets the OsidSession associated with the credential entry notification service.
      Parameters:
      credentialEntryReceiver - the notification callback
      Returns:
      a CredentialEntryNotificationSession
      Throws:
      NullArgumentException - credentialEntryReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCredentialEntryNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialEntryNotification()} is {@code true} .

    • getCredentialEntryNotificationSessionForCourseCatalog

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

    • getCredentialEntryCourseCatalogSession

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

    • getCredentialEntryCourseCatalogAssignmentSession

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

    • getCredentialEntrySmartCourseCatalogSession

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

    • getAssessmentEntryLookupSession

      AssessmentEntryLookupSession getAssessmentEntryLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the assessment entry lookup service.
      Returns:
      an AssessmentEntryLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAssessmentEntryLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentEntryLookup()} is {@code true} .

    • getAssessmentEntryLookupSessionForCourseCatalog

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

    • getAssessmentEntryQuerySession

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

    • getAssessmentEntryQuerySessionForCourseCatalog

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

    • getAssessmentEntrySearchSession

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

    • getAssessmentEntrySearchSessionForCourseCatalog

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

    • getAssessmentEntryAdminSession

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

    • getAssessmentEntryAdminSessionForCourseCatalog

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

    • getAssessmentEntryNotificationSession

      AssessmentEntryNotificationSession getAssessmentEntryNotificationSession(AssessmentEntryReceiver assessmentEntryReceiver) throws OperationFailedException
      Gets the OsidSession associated with the assessment entry notification service.
      Parameters:
      assessmentEntryReceiver - the notification callback
      Returns:
      an AssessmentEntryNotificationSession
      Throws:
      NullArgumentException - assessmentEntryReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAssessmentEntryNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentEntryNotification()} is {@code true} .

    • getAssessmentEntryNotificationSessionForCourseCatalog

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

    • getAssessmentEntryCourseCatalogSession

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

    • getAssessmentEntryCourseCatalogAssignmentSession

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

    • getAssessmentEntrySmartCourseCatalogSession

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

    • getAwardEntryLookupSession

      AwardEntryLookupSession getAwardEntryLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the award entry lookup service.
      Returns:
      an AwardEntryLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAwardEntryLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAwardEntryLookup()} is {@code true} .

    • getAwardEntryLookupSessionForCourseCatalog

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

    • getAwardEntryQuerySession

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

    • getAwardEntryQuerySessionForCourseCatalog

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

    • getAwardEntrySearchSession

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

    • getAwardEntrySearchSessionForCourseCatalog

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

    • getAwardEntryAdminSession

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

    • getAwardEntryAdminSessionForCourseCatalog

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

    • getAwardEntryNotificationSession

      AwardEntryNotificationSession getAwardEntryNotificationSession(AwardEntryReceiver awardEntryReceiver) throws OperationFailedException
      Gets the OsidSession associated with the award entry notification service.
      Parameters:
      awardEntryReceiver - the notification callback
      Returns:
      an AwardEntryNotificationSession
      Throws:
      NullArgumentException - awardEntryReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAwardEntryNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAwardEntryNotification()} is {@code true} .

    • getAwardEntryNotificationSessionForCourseCatalog

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

    • getAwardEntryCourseCatalogSession

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

    • getAwardEntryCourseCatalogAssignmentSession

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

    • getAwardEntrySmartCourseCatalogSession

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

    • getCourseChronicleBatchManager

      CourseChronicleBatchManager getCourseChronicleBatchManager() throws OperationFailedException
      Gets the CourseChronicleBatchManager .
      Returns:
      a CourseChronicleBatchManager
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseChronicleBatchManager() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCoiurseChronicleBatchManager()} is {@code true} .