blackboard.platform.integration.service
Interface CourseIntegrationManager

public interface CourseIntegrationManager

Course-related integration methods.

Since:

Bb 9.0

Method Summary

CourseLmsIntegration	getCourseIntegration(Id courseId) Retrieves a course-integration mapping based on the provided courseId if the integration is active.
CourseLmsIntegration	getCourseIntegrationBySourcedId(java.lang.String sourcedidSource, java.lang.String sourcedidId) Retrieves a course-integration mapping based on the provided LMS sourcedid
boolean	isCourseIntegrated(Id courseId) Determines if a course is integrated (i.e hosted within an external LMS) Note: Do not use this function if you're going to load the course integration afterwards.
boolean	isCourseOwnedByIntegration(Id courseId) Determines if a course is owned by the integration.
void	saveCourseIntegration(CourseLmsIntegration courseIntegration) Saves a course-integration mapping

Method Detail

isCourseOwnedByIntegration

boolean isCourseOwnedByIntegration(Id courseId)

Determines if a course is owned by the integration. This explicitly excludes converted courses, as even though there is still a connection to the LMS, Academic Suite is considered the owner of the record.

Parameters:

courseId - Id of the Course

isCourseIntegrated

boolean isCourseIntegrated(Id courseId)

Determines if a course is integrated (i.e hosted within an external LMS)

Note: Do not use this function if you're going to load the course integration afterwards. Instead, just load the course integration with getCourseIntegration(blackboard.persist.Id) and treat a null response as a "No, the course is not integrated"

Also note that converted courses are still considered integrated, as the connection to the LMS is retained in order to handle SIS event proxying. Use CourseLmsIntegration.isConverted() to determine whether the course has been converted to AS.

Parameters:

courseId - Id of the Course

getCourseIntegration

CourseLmsIntegration getCourseIntegration(Id courseId)

Retrieves a course-integration mapping based on the provided courseId if the integration is active. If the integration is not active or if there is no integration for the provided courseId, returns null.

Note that converted courses are still considered integrated, as the connection to the LMS is retained in order to handle SIS event proxying. Use CourseLmsIntegration.isConverted() to determine whether the course has been converted to AS.

Parameters:

courseId - Id of the Course

Returns:

Data object, or null if there is no integration for the course

getCourseIntegrationBySourcedId

CourseLmsIntegration getCourseIntegrationBySourcedId(java.lang.String sourcedidSource,
                                                     java.lang.String sourcedidId)

Retrieves a course-integration mapping based on the provided LMS sourcedid

Parameters:

sourcedidSource - IMS SourcedId.Source from the LMS

sourcedidId - IMS SourcedId.Id from the LMS

saveCourseIntegration

void saveCourseIntegration(CourseLmsIntegration courseIntegration)

Saves a course-integration mapping

Throws:

PersistenceRuntimeException - If a failure occurs