Class RosterProfile


  • public final class RosterProfile
    extends Object
    The lab user list management profile.
    • Constructor Detail

      • RosterProfile

        public RosterProfile()
    • Method Detail

      • activeDirectoryGroupId

        public String activeDirectoryGroupId()
        Get the activeDirectoryGroupId property: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode.
        Returns:
        the activeDirectoryGroupId value.
      • withActiveDirectoryGroupId

        public RosterProfile withActiveDirectoryGroupId​(String activeDirectoryGroupId)
        Set the activeDirectoryGroupId property: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode.
        Parameters:
        activeDirectoryGroupId - the activeDirectoryGroupId value to set.
        Returns:
        the RosterProfile object itself.
      • ltiContextId

        public String ltiContextId()
        Get the ltiContextId property: The unique context identifier for the lab in the lms.
        Returns:
        the ltiContextId value.
      • withLtiContextId

        public RosterProfile withLtiContextId​(String ltiContextId)
        Set the ltiContextId property: The unique context identifier for the lab in the lms.
        Parameters:
        ltiContextId - the ltiContextId value to set.
        Returns:
        the RosterProfile object itself.
      • lmsInstance

        public String lmsInstance()
        Get the lmsInstance property: The base URI identifying the lms instance.
        Returns:
        the lmsInstance value.
      • withLmsInstance

        public RosterProfile withLmsInstance​(String lmsInstance)
        Set the lmsInstance property: The base URI identifying the lms instance.
        Parameters:
        lmsInstance - the lmsInstance value to set.
        Returns:
        the RosterProfile object itself.
      • ltiClientId

        public String ltiClientId()
        Get the ltiClientId property: The unique id of the azure lab services tool in the lms.
        Returns:
        the ltiClientId value.
      • withLtiClientId

        public RosterProfile withLtiClientId​(String ltiClientId)
        Set the ltiClientId property: The unique id of the azure lab services tool in the lms.
        Parameters:
        ltiClientId - the ltiClientId value to set.
        Returns:
        the RosterProfile object itself.
      • ltiRosterEndpoint

        public String ltiRosterEndpoint()
        Get the ltiRosterEndpoint property: The uri of the names and roles service endpoint on the lms for the class attached to this lab.
        Returns:
        the ltiRosterEndpoint value.
      • withLtiRosterEndpoint

        public RosterProfile withLtiRosterEndpoint​(String ltiRosterEndpoint)
        Set the ltiRosterEndpoint property: The uri of the names and roles service endpoint on the lms for the class attached to this lab.
        Parameters:
        ltiRosterEndpoint - the ltiRosterEndpoint value to set.
        Returns:
        the RosterProfile object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.