blackboard.platform.integration.service
Interface UserIntegrationManager

public interface UserIntegrationManager

User-related integration methods.

Since:

Bb 9.0

Method Summary

boolean	doesUserHaveIntegrations(Id userId) Determines if a user is a member of any integrations
java.util.List<UserLmsIntegration>	getAllIntegrationsByUserId(Id userId) Gets a list of all integration records for a user.
UserLmsIntegration	getUserLmsIntegrationBySourcedid(Id integrationId, java.lang.String sourcedidSource, java.lang.String sourcedidId) Gets a user's integration record for a single integration based on their LMS IMS SourcedId.
UserLmsIntegration	getUserLmsIntegrationByUserId(Id integrationId, Id userId) Gets a user's integration record for a single integration based on their User Id.
boolean	isUserOwnedByIntegration(Id userId) Determines if a user is owned by the integration.
void	removeUserFromLmsIntegration(Id userId, Id lmsIntegrationId, boolean heavy) Removes a user from an integration.
void	saveUserIntegration(UserLmsIntegration userLmsIntegration) Saves a user-integration mapping

Method Detail

isUserOwnedByIntegration

boolean isUserOwnedByIntegration(Id userId)
                                 throws IntegrationException

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

Parameters:

userId - Id of the User

Throws:

IntegrationException - if a problem occurs

doesUserHaveIntegrations

boolean doesUserHaveIntegrations(Id userId)
                                 throws IntegrationException

Determines if a user is a member of any integrations

Parameters:

userId - Id of the User

Returns:

true if the user is a converted user or is integrated externally, false if the user is a pure native user

Throws:

IntegrationException - if a problem occurs

getUserLmsIntegrationBySourcedid

UserLmsIntegration getUserLmsIntegrationBySourcedid(Id integrationId,
                                                    java.lang.String sourcedidSource,
                                                    java.lang.String sourcedidId)
                                                    throws IntegrationException

Gets a user's integration record for a single integration based on their LMS IMS SourcedId.

Parameters:

integrationId - Id of the LmsIntegration to search in

sourcedidSource - IMS SourcedId.Source from the LMS

sourcedidId - IMS SourcedId.Id from the LMS

Throws:

IntegrationException - if a problem occurs

getUserLmsIntegrationByUserId

UserLmsIntegration getUserLmsIntegrationByUserId(Id integrationId,
                                                 Id userId)
                                                 throws IntegrationException

Gets a user's integration record for a single integration based on their User Id.

Parameters:

integrationId - Id of the LmsIntegration to search in

userId - Id of the User

Throws:

IntegrationException - if a problem occurs

getAllIntegrationsByUserId

java.util.List<UserLmsIntegration> getAllIntegrationsByUserId(Id userId)
                                                              throws IntegrationException

Gets a list of all integration records for a user.

Parameters:

userId - Id of the User

Throws:

IntegrationException - if a problem occurs

saveUserIntegration

void saveUserIntegration(UserLmsIntegration userLmsIntegration)
                         throws IntegrationException

Saves a user-integration mapping

Throws:

IntegrationException - if a problem occurs

removeUserFromLmsIntegration

void removeUserFromLmsIntegration(Id userId,
                                  Id lmsIntegrationId,
                                  boolean heavy)
                                  throws IntegrationException

Removes a user from an integration.

Parameters:

userId - Id of the User

lmsIntegrationId - Id of the LmsIntegration

heavy - In addition to removing the user from the integration, the following will happen:

• Remove the integration's role from the user account
• Unenroll the user from all of the integration's courses
• User's data source will be changed to that of the next-highest integration

Throws:

IntegrationException - if a problem occurs