org.tsugi.lti2

Class LTI2Vars

java.lang.Object

org.tsugi.lti2.LTI2Vars

public class LTI2Vars
extends Object

A class to capture the names of the valid LTI 2.0 substitution variables These are also capabilities - when used as a capability it indicates a willingness to subsitute these variables on launches. Taken from: http://www.imsglobal.org/lti/ltiv2p0/uml/purl.imsglobal.org/vocab/lti/v2/variable/index.html

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_VARIABLES ALL_VARIABLES - A list of all of the subsitution variables
static String	BASICOUTCOME_SOURCEDID BASICOUTCOME_SOURCEDID Enables the substitution variable $BasicOutcome.sourcedId
static String	BASICOUTCOME_URL BASICOUTCOME_URL Enables the substitution variable $BasicOutcome.url
static String	CONTEXT_ID
static String	CONTEXT_ID_HISTORY
static String	CONTEXT_LABEL
static String	CONTEXT_ORG CONTEXT_ORG A URI describing the organisational properties of the context from which a launch request originates (typically a CourseSection); for example, an ldap:// URI such as ldap://host.com:6666/cid=abc123, ou=dept,dc=plainjoe,dc=org.
static String	CONTEXT_SOURCEDID
static String	CONTEXT_TITLE
static String	CONTEXT_TYPE
static String	CONTEXT_TYPE_DEFAULT
static String	COURSEOFFERING_ACADEMICSESSION COURSEOFFERING_ACADEMICSESSION The text data that is used to describe the academic session for the course offering.
static String	COURSEOFFERING_CREDITS COURSEOFFERING_CREDITS The default credits set for this Course Offering In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/defaultCredits/textString
static String	COURSEOFFERING_LABEL COURSEOFFERING_LABEL A human readable label for the Course Offering In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/label
static String	COURSEOFFERING_LONGDESCRIPTION COURSEOFFERING_LONGDESCRIPTION A long description of the Course Offering.
static String	COURSEOFFERING_SHORTDESCRIPTION COURSEOFFERING_SHORTDESCRIPTION A short description of the Course Offering.
static String	COURSEOFFERING_SOURCEDID COURSEOFFERING_SOURCEDID The LIS identifier for the Course Offering.
static String	COURSEOFFERING_TITLE COURSEOFFERING_TITLE The title of the Course Offering.
static String	COURSESECTION_COURSENUMBER COURSESECTION_COURSENUMBER The course number, such as "Biology 101".
static String	COURSESECTION_CREDITS COURSESECTION_CREDITS The default credits set for the Course Section.
static String	COURSESECTION_DATASOURCE COURSESECTION_DATASOURCE An identifier for the original source system of the CourseSection object.
static String	COURSESECTION_DEPT COURSESECTION_DEPT The department within which the Course Section is offered.
static String	COURSESECTION_ENROLLCONTROL_ALLOWED COURSESECTION_ENROLLCONTROL_ALLOWED A boolean value that specifies whether the Tool Provider can enroll people in the Course Section.
static String	COURSESECTION_ENROLLCONTROLL_ACCEPT COURSESECTION_ENROLLCONTROLL_ACCEPT A boolean value that specifies whether the Course Section is accepting enrollments.
static String	COURSESECTION_LABEL COURSESECTION_LABEL A human readable label for the Course Section.
static String	COURSESECTION_LONGDESCRIPTION COURSESECTION_LONGDESCRIPTION A long description of the Course Section.
static String	COURSESECTION_MAXNUMBEROFSTUDENTS COURSESECTION_MAXNUMBEROFSTUDENTS The maximum number of students that can be enrolled in the Course Section.
static String	COURSESECTION_NUMBEROFSTUDENTS COURSESECTION_NUMBEROFSTUDENTS The number of students who are enrolled in the Course Section.
static String	COURSESECTION_SHORTDESCRIPTION COURSESECTION_SHORTDESCRIPTION A short description of the Course Section.
static String	COURSESECTION_SOURCEDID COURSESECTION_SOURCEDID The LIS identifier for the Course Section In the LIS Database, this value corresponds to courseSection/sourcedId
static String	COURSESECTION_SOURCESECTIONID COURSESECTION_SOURCESECTIONID The identifier for the source Course Section from which the target Course Section was cloned.
static String	COURSESECTION_TIMEFRAME_BEGIN COURSESECTION_TIMEFRAME_BEGIN The date and time when the Course Section becomes available.
static String	COURSESECTION_TIMEFRAME_END COURSESECTION_TIMEFRAME_END The date and time after which the Course Section is no longer available.
static String	COURSESECTION_TITLE COURSESECTION_TITLE The title of the Course Section.
static String	COURSETEMPLATE_COURSENUMBER COURSETEMPLATE_COURSENUMBER The course number, such as "Biology 101".
static String	COURSETEMPLATE_CREDITS COURSETEMPLATE_CREDITS The default credits set for this Course Template.
static String	COURSETEMPLATE_LABEL COURSETEMPLATE_LABEL A human readable label used to help identify the Course Template.
static String	COURSETEMPLATE_LONGDESCRIPTION COURSETEMPLATE_LONGDESCRIPTION A long description of the Course Template.
static String	COURSETEMPLATE_SHORTDESCRIPTION COURSETEMPLATE_SHORTDESCRIPTION A short description of the Course Template.
static String	COURSETEMPLATE_SOURCEDID COURSETEMPLATE_SOURCEDID The LIS identifier for the Course Template.
static String	COURSETEMPLATE_TITLE COURSETEMPLATE_TITLE The title of the Course Template.
static String	GROUP_EMAIL GROUP_EMAIL An email address used for posting messages to members of the group.
static String	GROUP_ENROLLCONTROL_ACCEPT GROUP_ENROLLCONTROL_ACCEPT A boolean value that specifies whether the Group is accepting enrollments.
static String	GROUP_ENROLLCONTROL_ALLOWED GROUP_ENROLLCONTROL_ALLOWED A boolean value that specifies whether the Tool Provider can enroll people in the Group.
static String	GROUP_GROUPTYPE GROUP_GROUPTYPE A URI that uniquely identifies the type of group.
static String	GROUP_LONGDESCRIPTION GROUP_LONGDESCRIPTION A long description of the Group.
static String	GROUP_PARENTID GROUP_PARENTID An identifier for the parent group within which the target group is nested.
static String	GROUP_SHORTDESCRIPTION GROUP_SHORTDESCRIPTION A short description of the Group.
static String	GROUP_SOURCEDID GROUP_SOURCEDID The LIS identifier for the Group.
static String	GROUP_TIMEFRAME_BEGIN GROUP_TIMEFRAME_BEGIN The date and time when access to Group resources begins.
static String	GROUP_TIMEFRAME_END GROUP_TIMEFRAME_END The date and time when access to Group resources ends.
static String	GROUP_URL GROUP_URL The web address of the Group.
static String	LINEITEM_DATASOURCE LINEITEM_DATASOURCE An identifier for the original source system of the LineItem record.
static String	LINEITEM_RESULTVALUE_MAX LINEITEM_RESULTVALUE_MAX The maximum numeric score that a learner may earn on the assignment associated with this LineItem.
static String	LINEITEM_SOURCEDID LINEITEM_SOURCEDID The LIS identifier for the LineItem In the LIS Database, this value corresponds to lineItemRecord/sourcedId
static String	LINEITEM_TYPE LINEITEM_TYPE A URI that uniquely identifies the LineItem type.
static String	LINEITEM_TYPE_DISPLAYNAME LINEITEM_TYPE_DISPLAYNAME The display name for the LineItemType.
static String	LTILINK_CUSTOM_URL LTILINK_CUSTOM_URL The endpoint URL for accessing link-level tool settings.
static String	MEMBERSHIP_COLLECTIONSOURCEDID MEMBERSHIP_COLLECTIONSOURCEDID The LIS identifier for the organizational unit (Course Section, Group, etc.) to which the Membership pertains.
static String	MEMBERSHIP_CREATEDTIMESTAMP MEMBERSHIP_CREATEDTIMESTAMP The date and time when the membership role was created.
static String	MEMBERSHIP_DATASOURCE MEMBERSHIP_DATASOURCE An identifier for the original source system of the Membership record.
static String	MEMBERSHIP_PERSONSOURCEDID MEMBERSHIP_PERSONSOURCEDID The LIS identifier for the Person associated with the Membership.
static String	MEMBERSHIP_ROLE MEMBERSHIP_ROLE A comma separated list of roles that the Person has within the organizational unit.
static String	MEMBERSHIP_ROLE_INSTRUCTOR
static String	MEMBERSHIP_ROLE_LEARNER
static String	MEMBERSHIP_SOURCEDID MEMBERSHIP_SOURCEDID The LIS identifier for the Membership.
static String	MEMBERSHIP_STATUS MEMBERSHIP_STATUS Indicates if the membership is active or inactive.
static String	MESSAGE_LOCALE MESSAGE_LOCALE The locale of this launch
static String	PERSON_ADDRESS_COUNTRY PERSON_ADDRESS_COUNTRY The country within the user's address.
static String	PERSON_ADDRESS_LOCALITY PERSON_ADDRESS_LOCALITY The city, town, or other locality within the user's address.
static String	PERSON_ADDRESS_POSTCODE PERSON_ADDRESS_POSTCODE The postal code within the user's address.
static String	PERSON_ADDRESS_STATEPR PERSON_ADDRESS_STATEPR The state or province within the user's address.
static String	PERSON_ADDRESS_STREET1 PERSON_ADDRESS_STREET1 The first line of the user's street address.
static String	PERSON_ADDRESS_STREET2 PERSON_ADDRESS_STREET2 The second line of the user's street address.
static String	PERSON_ADDRESS_STREET3 PERSON_ADDRESS_STREET3 The third line of the user's street address.
static String	PERSON_ADDRESS_STREET4 PERSON_ADDRESS_STREET4 The fourth line of the user's street address.
static String	PERSON_ADDRESS_TIMEZONE PERSON_ADDRESS_TIMEZONE The user's time zone.
static String	PERSON_EMAIL_PERSONAL PERSON_EMAIL_PERSONAL The user's personal email address In the LIS Database, this value corresponds to person/contactinfo[contactinfoType/instanceValu e/text="Email_Personal"]/contactinfoValue /text
static String	PERSON_EMAIL_PRIMARY PERSON_EMAIL_PRIMARY The user's primary email address.
static String	PERSON_NAME_FAMILY PERSON_NAME_FAMILY The family name of the user.
static String	PERSON_NAME_FULL PERSON_NAME_FULL The full name of the user.
static String	PERSON_NAME_GIVEN PERSON_NAME_GIVEN The given name of the user.
static String	PERSON_NAME_MIDDLE PERSON_NAME_MIDDLE The middle name of the user.
static String	PERSON_NAME_PREFIX PERSON_NAME_PREFIX The prefix for the user's name, such as Dr., Mr., Ms. etc.
static String	PERSON_NAME_SUFFIX PERSON_NAME_SUFFIX The suffix for the user's name, such as Jr., II, etc.
static String	PERSON_PHONE_HOME PERSON_PHONE_HOME The user's home phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoType/instanceValue/text="Telephone_Home"]/contactinfoValue /text
static String	PERSON_PHONE_MOBILE PERSON_PHONE_MOBILE The user's mobile phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo[contactinfoType /instanceValue/text="Mobile"] /contactInfoValue/text
static String	PERSON_PHONE_PRIMARY PERSON_PHONE_PRIMARY The user's primary phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoTyp e/instanceValue/text="Telephone_Primary"]/contactinfoValue /text
static String	PERSON_PHONE_WORK PERSON_PHONE_WORK The user's work phone number.
static String	PERSON_SMS PERSON_SMS The number at which the user prefers to receive SMS text messages.
static String	PERSON_SOURCEDID PERSON_SOURCEDID The LIS identifier for the user.
static String	PERSON_WEBADDRESS PERSON_WEBADDRESS The user's web address.
static String	RESOURCELINK_DESCRIPTION RESOURCELINK_DESCRIPTION A plain text description of the link’s destination, suitable for display alongside the link.
static String	RESOURCELINK_ID RESOURCELINK_ID This is the local identifier for the resource link within the Tool Consumer system from which the launch occurred.
static String	RESOURCELINK_ID_HISTORY RESOURCELINK_ID_HISTORY A comma-separated list of URL-encoded resource link ID values representing the ID of the link from a previous copy of the context; the most recent copy should appear first in the list followed by any earlier IDs in reverse chronological order.
static String	RESOURCELINK_TITLE RESOURCELINK_TITLE A plain text title for the resource.
static String	RESULT_COMMENT RESULT_COMMENT A comment associated with the outcome which may be made visible to the student.
static String	RESULT_CREATEDTIMESTAMP RESULT_CREATEDTIMESTAMP The date and time when the Result was created.
static String	RESULT_DATASOURCE RESULT_DATASOURCE An identifier for the original source system of the Result record.
static String	RESULT_RESULTSCORE RESULT_RESULTSCORE The score that the learner earned on the assignment or activity to which this Result pertains.
static String	RESULT_SOURCEDID RESULT_SOURCEDID The LIS identifier for the Result resource.
static String	RESULT_URL RESULT_URL The URL of the Result resource.
static String	TOOLCONSUMERINFO_PRODUCTFAMILYCODE TOOLCONSUMERINFO_PRODUCTFAMILYCODE The code for the product (i.e.
static String	TOOLCONSUMERINFO_VERSION TOOLCONSUMERINFO_VERSION The code for the product (i.e.
static String	TOOLCONSUMERPROFILE_URL
static String	TOOLPROXY_CUSTOM_URL TOOLPROXY_CUSTOM_URL The endpoint URL for accessing system-wide tool settings.
static String	TOOLPROXYBINDING_CUSTOM_URL TOOLPROXYBINDING_CUSTOM_URL The endpoint URL for accessing context-level tool settings.
static String	USER_ID USER_ID Corresponds to the user_id launch parameterfrom the LaunchMixin class.
static String	USER_IMAGE USER_IMAGE The URL for an image of the user suitable for use as a profile picture or avatar.
static String	USER_ORG USER_ORG A URI describing the user's organisational properties; for example, an ldap:// URI such as ldap://host.com:6666/uid=user,ou=people,dc=e xample,dc=com.
static String	USER_USERNAME USER_USERNAME The username that identifies the user within the Tool Consumer system.

Constructor Summary

Constructors

Constructor and Description
LTI2Vars()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_ORG

public static final String CONTEXT_ORG

CONTEXT_ORG A URI describing the organisational properties of the context from which a launch request originates (typically a CourseSection); for example, an ldap:// URI such as ldap://host.com:6666/cid=abc123, ou=dept,dc=plainjoe,dc=org. If more than one format of organisational URI is specified, each should be separated with a space.

See Also:

Constant Field Values

CONTEXT_ID

public static final String CONTEXT_ID

See Also:

Constant Field Values

CONTEXT_TYPE

public static final String CONTEXT_TYPE

See Also:

Constant Field Values

CONTEXT_TYPE_DEFAULT

public static final String CONTEXT_TYPE_DEFAULT

See Also:

Constant Field Values

CONTEXT_LABEL

public static final String CONTEXT_LABEL

See Also:

Constant Field Values

CONTEXT_TITLE

public static final String CONTEXT_TITLE

See Also:

Constant Field Values

CONTEXT_ID_HISTORY

public static final String CONTEXT_ID_HISTORY

See Also:

Constant Field Values

TOOLCONSUMERPROFILE_URL

public static final String TOOLCONSUMERPROFILE_URL

See Also:

Constant Field Values

CONTEXT_SOURCEDID

public static final String CONTEXT_SOURCEDID

See Also:

Constant Field Values

COURSEOFFERING_ACADEMICSESSION

public static final String COURSEOFFERING_ACADEMICSESSION

COURSEOFFERING_ACADEMICSESSION The text data that is used to describe the academic session for the course offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/defaultCredits/textString

See Also:

Constant Field Values

COURSEOFFERING_CREDITS

public static final String COURSEOFFERING_CREDITS

COURSEOFFERING_CREDITS The default credits set for this Course Offering In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/defaultCredits/textString

See Also:

Constant Field Values

COURSEOFFERING_LABEL

public static final String COURSEOFFERING_LABEL

COURSEOFFERING_LABEL A human readable label for the Course Offering In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/label

See Also:

Constant Field Values

COURSEOFFERING_LONGDESCRIPTION

public static final String COURSEOFFERING_LONGDESCRIPTION

COURSEOFFERING_LONGDESCRIPTION A long description of the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/catal ogDescription/longDescription

See Also:

Constant Field Values

COURSEOFFERING_SHORTDESCRIPTION

public static final String COURSEOFFERING_SHORTDESCRIPTION

COURSEOFFERING_SHORTDESCRIPTION A short description of the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/catal ogDescription/shortDescription

See Also:

Constant Field Values

COURSEOFFERING_SOURCEDID

public static final String COURSEOFFERING_SOURCEDID

COURSEOFFERING_SOURCEDID The LIS identifier for the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/sourcedId

See Also:

Constant Field Values

COURSEOFFERING_TITLE

public static final String COURSEOFFERING_TITLE

COURSEOFFERING_TITLE The title of the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/title

See Also:

Constant Field Values

COURSESECTION_COURSENUMBER

public static final String COURSESECTION_COURSENUMBER

COURSESECTION_COURSENUMBER The course number, such as "Biology 101". In general, this number is not just a numeric value. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/courseNumber/textString

See Also:

Constant Field Values

COURSESECTION_CREDITS

public static final String COURSESECTION_CREDITS

COURSESECTION_CREDITS The default credits set for the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/defaultCredits/textString

See Also:

Constant Field Values

COURSESECTION_DATASOURCE

public static final String COURSESECTION_DATASOURCE

COURSESECTION_DATASOURCE An identifier for the original source system of the CourseSection object. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/dataSource

See Also:

Constant Field Values

COURSESECTION_DEPT

public static final String COURSESECTION_DEPT

COURSESECTION_DEPT The department within which the Course Section is offered. In the LIS Database, this value corresponds to courseSectionRecord/course Section/org[type/textString="Dept"]/orgName/textString

See Also:

Constant Field Values

COURSESECTION_ENROLLCONTROL_ALLOWED

public static final String COURSESECTION_ENROLLCONTROL_ALLOWED

COURSESECTION_ENROLLCONTROL_ALLOWED A boolean value that specifies whether the Tool Provider can enroll people in the Course Section. The value false indicates that only the source system can enroll people. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/enrollControl/enrollAllowed

See Also:

Constant Field Values

COURSESECTION_ENROLLCONTROLL_ACCEPT

public static final String COURSESECTION_ENROLLCONTROLL_ACCEPT

COURSESECTION_ENROLLCONTROLL_ACCEPT A boolean value that specifies whether the Course Section is accepting enrollments. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/enrollControl/enrollAccept

See Also:

Constant Field Values

COURSESECTION_LABEL

public static final String COURSESECTION_LABEL

COURSESECTION_LABEL A human readable label for the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/label

See Also:

Constant Field Values

COURSESECTION_LONGDESCRIPTION

public static final String COURSESECTION_LONGDESCRIPTION

COURSESECTION_LONGDESCRIPTION A long description of the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/catalog Description/longDescription

See Also:

Constant Field Values

COURSESECTION_MAXNUMBEROFSTUDENTS

public static final String COURSESECTION_MAXNUMBEROFSTUDENTS

COURSESECTION_MAXNUMBEROFSTUDENTS The maximum number of students that can be enrolled in the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/maxNumberofStudents

See Also:

Constant Field Values

COURSESECTION_NUMBEROFSTUDENTS

public static final String COURSESECTION_NUMBEROFSTUDENTS

COURSESECTION_NUMBEROFSTUDENTS The number of students who are enrolled in the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/numberofStudents

See Also:

Constant Field Values

COURSESECTION_SHORTDESCRIPTION

public static final String COURSESECTION_SHORTDESCRIPTION

COURSESECTION_SHORTDESCRIPTION A short description of the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/catalog Description/shortDescription

See Also:

Constant Field Values

COURSESECTION_SOURCESECTIONID

public static final String COURSESECTION_SOURCESECTIONID

COURSESECTION_SOURCESECTIONID The identifier for the source Course Section from which the target Course Section was cloned. In the LIS Database, this value corresponds to createCourseSectionFromCourseSectionRequest/sourcedId

See Also:

Constant Field Values

COURSESECTION_SOURCEDID

public static final String COURSESECTION_SOURCEDID

COURSESECTION_SOURCEDID The LIS identifier for the Course Section In the LIS Database, this value corresponds to courseSection/sourcedId

See Also:

Constant Field Values

COURSESECTION_TIMEFRAME_BEGIN

public static final String COURSESECTION_TIMEFRAME_BEGIN

COURSESECTION_TIMEFRAME_BEGIN The date and time when the Course Section becomes available. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/timeFrame/begin

See Also:

Constant Field Values

COURSESECTION_TIMEFRAME_END

public static final String COURSESECTION_TIMEFRAME_END

COURSESECTION_TIMEFRAME_END The date and time after which the Course Section is no longer available. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/timeFrame/end

See Also:

Constant Field Values

COURSESECTION_TITLE

public static final String COURSESECTION_TITLE

COURSESECTION_TITLE The title of the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/title

See Also:

Constant Field Values

COURSETEMPLATE_COURSENUMBER

public static final String COURSETEMPLATE_COURSENUMBER

COURSETEMPLATE_COURSENUMBER The course number, such as "Biology 101". In general, this number is not just a numeric value. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/courseNumber/textString

See Also:

Constant Field Values

COURSETEMPLATE_CREDITS

public static final String COURSETEMPLATE_CREDITS

COURSETEMPLATE_CREDITS The default credits set for this Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/defaultCredits/textString

See Also:

Constant Field Values

COURSETEMPLATE_LABEL

public static final String COURSETEMPLATE_LABEL

COURSETEMPLATE_LABEL A human readable label used to help identify the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/label/textString

See Also:

Constant Field Values

COURSETEMPLATE_LONGDESCRIPTION

public static final String COURSETEMPLATE_LONGDESCRIPTION

COURSETEMPLATE_LONGDESCRIPTION A long description of the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/catal ogDescription/longDescription

See Also:

Constant Field Values

COURSETEMPLATE_SHORTDESCRIPTION

public static final String COURSETEMPLATE_SHORTDESCRIPTION

COURSETEMPLATE_SHORTDESCRIPTION A short description of the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/catal ogDescription/shortDescription

See Also:

Constant Field Values

COURSETEMPLATE_SOURCEDID

public static final String COURSETEMPLATE_SOURCEDID

COURSETEMPLATE_SOURCEDID The LIS identifier for the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/sourcedId

See Also:

Constant Field Values

COURSETEMPLATE_TITLE

public static final String COURSETEMPLATE_TITLE

COURSETEMPLATE_TITLE The title of the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/title/textString

See Also:

Constant Field Values

GROUP_EMAIL

public static final String GROUP_EMAIL

GROUP_EMAIL An email address used for posting messages to members of the group. In the LIS Database, this value corresponds to groupRecord/group/email

See Also:

Constant Field Values

GROUP_ENROLLCONTROL_ACCEPT

public static final String GROUP_ENROLLCONTROL_ACCEPT

GROUP_ENROLLCONTROL_ACCEPT A boolean value that specifies whether the Group is accepting enrollments. In the LIS Database, this value corresponds to groupRecord/group/enrollControl/enrollAccept

See Also:

Constant Field Values

GROUP_ENROLLCONTROL_ALLOWED

public static final String GROUP_ENROLLCONTROL_ALLOWED

GROUP_ENROLLCONTROL_ALLOWED A boolean value that specifies whether the Tool Provider can enroll people in the Group. The value false indicates that only the source system can enroll people. In the LIS Database, this value corresponds to groupRecord/group/enrollControl/enrollAllowed

See Also:

Constant Field Values

GROUP_GROUPTYPE

public static final String GROUP_GROUPTYPE

GROUP_GROUPTYPE A URI that uniquely identifies the type of group. This convention differs from the LIS convention of using a structured object to describe the type of a group. Ideally, the URI should resolve to JSON-LD document that describes the group type. However, any URI that uniquely identifies the group type in accordance with the rules of the grouptype scheme is acceptable.

See Also:

Constant Field Values

GROUP_LONGDESCRIPTION

public static final String GROUP_LONGDESCRIPTION

GROUP_LONGDESCRIPTION A long description of the Group. In the LIS Database, this value corresponds to groupRecord/group/description/longDescription

See Also:

Constant Field Values

GROUP_PARENTID

public static final String GROUP_PARENTID

GROUP_PARENTID An identifier for the parent group within which the target group is nested. In the LIS Database, this value corresponds to groupRecord/group/relationship[relation="Parent"]/sourcedId

See Also:

Constant Field Values

GROUP_SHORTDESCRIPTION

public static final String GROUP_SHORTDESCRIPTION

GROUP_SHORTDESCRIPTION A short description of the Group. In the LIS Database, this value corresponds to groupRecord/group/description/shortDescription

See Also:

Constant Field Values

GROUP_SOURCEDID

public static final String GROUP_SOURCEDID

GROUP_SOURCEDID The LIS identifier for the Group. In the LIS Database, this value corresponds to groupRecord/sourcedId

See Also:

Constant Field Values

GROUP_TIMEFRAME_BEGIN

public static final String GROUP_TIMEFRAME_BEGIN

GROUP_TIMEFRAME_BEGIN The date and time when access to Group resources begins. In the LIS Database, this value corresponds to groupRecord/group/timeframe/begin

See Also:

Constant Field Values

GROUP_TIMEFRAME_END

public static final String GROUP_TIMEFRAME_END

GROUP_TIMEFRAME_END The date and time when access to Group resources ends. In the LIS Database, this value corresponds to groupRecord/group/timeframe/end

See Also:

Constant Field Values

GROUP_URL

public static final String GROUP_URL

GROUP_URL The web address of the Group. In the LIS Database, this value corresponds to groupRecord/group/url

See Also:

Constant Field Values

LINEITEM_DATASOURCE

public static final String LINEITEM_DATASOURCE

LINEITEM_DATASOURCE An identifier for the original source system of the LineItem record. In the LIS Database, this value corresponds to lineItemRecord/lineItem/dataSource

See Also:

Constant Field Values

LINEITEM_RESULTVALUE_MAX

public static final String LINEITEM_RESULTVALUE_MAX

LINEITEM_RESULTVALUE_MAX The maximum numeric score that a learner may earn on the assignment associated with this LineItem. In the LIS Database, this value corresponds to resultValueRecord/resultValue/valueRange/max where resultValueRecord.sourcedId = lineItemRecord/lineItem/resultValueSourcedId

See Also:

Constant Field Values

LINEITEM_SOURCEDID

public static final String LINEITEM_SOURCEDID

LINEITEM_SOURCEDID The LIS identifier for the LineItem In the LIS Database, this value corresponds to lineItemRecord/sourcedId

See Also:

Constant Field Values

LINEITEM_TYPE

public static final String LINEITEM_TYPE

LINEITEM_TYPE A URI that uniquely identifies the LineItem type. This convention differs from the LIS convention of using a structured object to describe LineItem types. The URI should resolve to a JSON- LD resource that describes the LineItem type. As a best practice the URI should start with a base URL that identifies the LineItemType vocabulary and end with a relative URL for a type within that vocabulary. In the LIS Database, the LineItem type is given by lineItemRecord/lineItem/lineItemType

See Also:

Constant Field Values

LINEITEM_TYPE_DISPLAYNAME

public static final String LINEITEM_TYPE_DISPLAYNAME

LINEITEM_TYPE_DISPLAYNAME The display name for the LineItemType. In the LIS Database, this value corresponds to lineItemTypeRecord/lineItemType/displayName

See Also:

Constant Field Values

LTILINK_CUSTOM_URL

public static final String LTILINK_CUSTOM_URL

LTILINK_CUSTOM_URL The endpoint URL for accessing link-level tool settings.

See Also:

Constant Field Values

MEMBERSHIP_COLLECTIONSOURCEDID

public static final String MEMBERSHIP_COLLECTIONSOURCEDID

MEMBERSHIP_COLLECTIONSOURCEDID The LIS identifier for the organizational unit (Course Section, Group, etc.) to which the Membership pertains. In the LIS Database, this value corresponds to membershipRecord/membership/collectionSourcedId

See Also:

Constant Field Values

MEMBERSHIP_CREATEDTIMESTAMP

public static final String MEMBERSHIP_CREATEDTIMESTAMP

MEMBERSHIP_CREATEDTIMESTAMP The date and time when the membership role was created. If the Person has more than one role within the organizational unit, then this value is a comma separated list corresponding to the roles listed by the Membership.role variable. In the LIS Database, this value corresponds to membershipRecord/membership/member/role/dateTime

See Also:

Constant Field Values

MEMBERSHIP_DATASOURCE

public static final String MEMBERSHIP_DATASOURCE

MEMBERSHIP_DATASOURCE An identifier for the original source system of the Membership record. In the LIS Database, this value corresponds to membershipRecord/membership/member/role/dataSource

See Also:

Constant Field Values

MEMBERSHIP_PERSONSOURCEDID

public static final String MEMBERSHIP_PERSONSOURCEDID

MEMBERSHIP_PERSONSOURCEDID The LIS identifier for the Person associated with the Membership. In the LIS Database, this value corresponds to membershipRecord/membership/member/personSourcedId

See Also:

Constant Field Values

MEMBERSHIP_ROLE

public static final String MEMBERSHIP_ROLE

MEMBERSHIP_ROLE A comma separated list of roles that the Person has within the organizational unit. In the LIS Database, this value corresponds to membershipRecord/membership/member/role/roleType

See Also:

Constant Field Values

MEMBERSHIP_ROLE_LEARNER

public static final String MEMBERSHIP_ROLE_LEARNER

See Also:

Constant Field Values

MEMBERSHIP_ROLE_INSTRUCTOR

public static final String MEMBERSHIP_ROLE_INSTRUCTOR

See Also:

Constant Field Values

MEMBERSHIP_SOURCEDID

public static final String MEMBERSHIP_SOURCEDID

MEMBERSHIP_SOURCEDID The LIS identifier for the Membership. In the LIS Database, this value corresponds to membershipRecord/sourcedId

See Also:

Constant Field Values

MEMBERSHIP_STATUS

public static final String MEMBERSHIP_STATUS

MEMBERSHIP_STATUS Indicates if the membership is active or inactive. In accordance with the LIS specification, the value should be either Active or Inactive. If the Person has more than one role within the organizational unit, then this value is a comma separated list, where the values are ordered in correspondence with the roles named by the Membership.role variable. In the LIS Database, this value corresponds to membershipRecord/membership/member/role/status

See Also:

Constant Field Values

PERSON_ADDRESS_COUNTRY

public static final String PERSON_ADDRESS_COUNTRY

PERSON_ADDRESS_COUNTRY The country within the user's address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/ instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="Country"]/instanceValue/text

See Also:

Constant Field Values

PERSON_ADDRESS_LOCALITY

public static final String PERSON_ADDRESS_LOCALITY

PERSON_ADDRESS_LOCALITY The city, town, or other locality within the user's address. In the LIS Database, this value corresponds to personRecord/person/ad dress/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="Locality"]/instanceValue/text

See Also:

Constant Field Values

PERSON_ADDRESS_POSTCODE

public static final String PERSON_ADDRESS_POSTCODE

PERSON_ADDRESS_POSTCODE The postal code within the user's address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/ instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="Postcode"]/instanceValue/text

See Also:

Constant Field Values

PERSON_ADDRESS_STATEPR

public static final String PERSON_ADDRESS_STATEPR

PERSON_ADDRESS_STATEPR The state or province within the user's address. In the LIS Database, this value corresponds to personRecord/person/address/[address Type/instanceValue/text="Preferred"]addressPart /nameValuePair/[instanceName/text="Statepr"]/instanceValue/text

See Also:

Constant Field Values

PERSON_ADDRESS_STREET1

public static final String PERSON_ADDRESS_STREET1

PERSON_ADDRESS_STREET1 The first line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[address Type/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="NonFieldedStreetAddress1"]/instanceValue /text

See Also:

Constant Field Values

PERSON_ADDRESS_STREET2

public static final String PERSON_ADDRESS_STREET2

PERSON_ADDRESS_STREET2 The second line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[address Type/instanceValue/text="Preferred"] addressPart /nameValuePair[instanceName/text="NonFieldedStreetAddress2"] /instanceValue/text

See Also:

Constant Field Values

PERSON_ADDRESS_STREET3

public static final String PERSON_ADDRESS_STREET3

PERSON_ADDRESS_STREET3 The third line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[address Type/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="NonFieldedStreetAddress3"] /instanceValue/text

See Also:

Constant Field Values

PERSON_ADDRESS_STREET4

public static final String PERSON_ADDRESS_STREET4

PERSON_ADDRESS_STREET4 The fourth line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[address Type/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="NonFieldedStreetAddress4"] /instanceValue/text

See Also:

Constant Field Values

PERSON_ADDRESS_TIMEZONE

public static final String PERSON_ADDRESS_TIMEZONE

PERSON_ADDRESS_TIMEZONE The user's time zone. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Pre ferred"]addressPart /nameValuePair /[instanceName/text="Timezone"]/instanceValue/text

See Also:

Constant Field Values

PERSON_EMAIL_PERSONAL

public static final String PERSON_EMAIL_PERSONAL

PERSON_EMAIL_PERSONAL The user's personal email address In the LIS Database, this value corresponds to person/contactinfo[contactinfoType/instanceValu e/text="Email_Personal"]/contactinfoValue /text

See Also:

Constant Field Values

PERSON_EMAIL_PRIMARY

public static final String PERSON_EMAIL_PRIMARY

PERSON_EMAIL_PRIMARY The user's primary email address. In the LIS Database, this value corresponds to personRecord/person/contactinfo[contactinfoType /instanceValue/text="Email_Primary"] /contactinfoValue/text

See Also:

Constant Field Values

PERSON_NAME_FAMILY

public static final String PERSON_NAME_FAMILY

PERSON_NAME_FAMILY The family name of the user. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/ text="Family”]/instanceValue/text

See Also:

Constant Field Values

PERSON_NAME_FULL

public static final String PERSON_NAME_FULL

PERSON_NAME_FULL The full name of the user. In the LIS Database, this value corresponds to personRecord/person/formname/[formnameType/inst anceValue/text="Full"] /formattedName/text

See Also:

Constant Field Values

PERSON_NAME_GIVEN

public static final String PERSON_NAME_GIVEN

PERSON_NAME_GIVEN The given name of the user. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/ text="Given”]/instanceValue/text

See Also:

Constant Field Values

PERSON_NAME_MIDDLE

public static final String PERSON_NAME_MIDDLE

PERSON_NAME_MIDDLE The middle name of the user. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/ text="Middle”]/instanceValue/text

See Also:

Constant Field Values

PERSON_NAME_PREFIX

public static final String PERSON_NAME_PREFIX

PERSON_NAME_PREFIX The prefix for the user's name, such as Dr., Mr., Ms. etc. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/text="Prefix”]/inst anceValue/text

See Also:

Constant Field Values

PERSON_NAME_SUFFIX

public static final String PERSON_NAME_SUFFIX

PERSON_NAME_SUFFIX The suffix for the user's name, such as Jr., II, etc. In the LIS Database, this value corresponds to personRec ord/person/name/partName[instanceName/text="Suffix”]/instanceValue/tex t

See Also:

Constant Field Values

PERSON_PHONE_HOME

public static final String PERSON_PHONE_HOME

PERSON_PHONE_HOME The user's home phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoType/instanceValue/text="Telephone_Home"]/contactinfoValue /text

See Also:

Constant Field Values

PERSON_PHONE_MOBILE

public static final String PERSON_PHONE_MOBILE

PERSON_PHONE_MOBILE The user's mobile phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo[contactinfoType /instanceValue/text="Mobile"] /contactInfoValue/text

See Also:

Constant Field Values

PERSON_PHONE_PRIMARY

public static final String PERSON_PHONE_PRIMARY

PERSON_PHONE_PRIMARY The user's primary phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoTyp e/instanceValue/text="Telephone_Primary"]/contactinfoValue /text

See Also:

Constant Field Values

PERSON_PHONE_WORK

public static final String PERSON_PHONE_WORK

PERSON_PHONE_WORK The user's work phone number. In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoType/instanceValue/text="Telephone_Work"]/contactinfoValue /text

See Also:

Constant Field Values

PERSON_SMS

public static final String PERSON_SMS

PERSON_SMS The number at which the user prefers to receive SMS text messages. In the LIS Database, this value corresponds to personRecord/perso n/contactinfo[contactinfoType/instanceValue/text="SMS"] /contactinfoValue/text

See Also:

Constant Field Values

PERSON_SOURCEDID

public static final String PERSON_SOURCEDID

PERSON_SOURCEDID The LIS identifier for the user. In the LIS Database, this value corresponds to personRecord/sourcedId

See Also:

Constant Field Values

PERSON_WEBADDRESS

public static final String PERSON_WEBADDRESS

PERSON_WEBADDRESS The user's web address. This could be a facebook address, a blog, or any other web address linked to the user. The value should be a URL. In the LIS Database, this value corresponds to personRecord/pe rson/contactinfo[contactinfoType/instanceValue/text="Web-Address"] /contactinfoValue/text

See Also:

Constant Field Values

RESOURCELINK_ID

public static final String RESOURCELINK_ID

RESOURCELINK_ID This is the local identifier for the resource link within the Tool Consumer system from which the launch occurred.

See Also:

Constant Field Values

RESOURCELINK_ID_HISTORY

public static final String RESOURCELINK_ID_HISTORY

RESOURCELINK_ID_HISTORY A comma-separated list of URL-encoded resource link ID values representing the ID of the link from a previous copy of the context; the most recent copy should appear first in the list followed by any earlier IDs in reverse chronological order. If the link was first added to the current context then this variable should have an empty value.

See Also:

Constant Field Values

RESOURCELINK_DESCRIPTION

public static final String RESOURCELINK_DESCRIPTION

RESOURCELINK_DESCRIPTION A plain text description of the link’s destination, suitable for display alongside the link.

See Also:

Constant Field Values

RESOURCELINK_TITLE

public static final String RESOURCELINK_TITLE

RESOURCELINK_TITLE A plain text title for the resource.

See Also:

Constant Field Values

RESULT_COMMENT

public static final String RESULT_COMMENT

RESULT_COMMENT A comment associated with the outcome which may be made visible to the student.

See Also:

Constant Field Values

RESULT_CREATEDTIMESTAMP

public static final String RESULT_CREATEDTIMESTAMP

RESULT_CREATEDTIMESTAMP The date and time when the Result was created. In the LIS Database, this value corresponds to

See Also:

Constant Field Values

RESULT_DATASOURCE

public static final String RESULT_DATASOURCE

RESULT_DATASOURCE An identifier for the original source system of the Result record. In the LIS Database, this value corresponds to resultRecord/result/dataSource

See Also:

Constant Field Values

RESULT_RESULTSCORE

public static final String RESULT_RESULTSCORE

RESULT_RESULTSCORE The score that the learner earned on the assignment or activity to which this Result pertains. In the LIS Database, this value corresponds to resultRecord/result/resultScore/textString

See Also:

Constant Field Values

RESULT_SOURCEDID

public static final String RESULT_SOURCEDID

RESULT_SOURCEDID The LIS identifier for the Result resource.

See Also:

Constant Field Values

RESULT_URL

public static final String RESULT_URL

RESULT_URL The URL of the Result resource. Client applications may issue an HTTP request to read, update or delete the resource at this URL.

See Also:

Constant Field Values

BASICOUTCOME_URL

public static final String BASICOUTCOME_URL

BASICOUTCOME_URL Enables the substitution variable $BasicOutcome.url

See Also:

Constant Field Values

BASICOUTCOME_SOURCEDID

public static final String BASICOUTCOME_SOURCEDID

BASICOUTCOME_SOURCEDID Enables the substitution variable $BasicOutcome.sourcedId

See Also:

Constant Field Values

TOOLCONSUMERINFO_PRODUCTFAMILYCODE

public static final String TOOLCONSUMERINFO_PRODUCTFAMILYCODE

TOOLCONSUMERINFO_PRODUCTFAMILYCODE The code for the product (i.e. like "sakai" or "learn")

See Also:

Constant Field Values

TOOLCONSUMERINFO_VERSION

public static final String TOOLCONSUMERINFO_VERSION

TOOLCONSUMERINFO_VERSION The code for the product (i.e. like "sakai" or "learn")

See Also:

Constant Field Values

TOOLPROXY_CUSTOM_URL

public static final String TOOLPROXY_CUSTOM_URL

TOOLPROXY_CUSTOM_URL The endpoint URL for accessing system-wide tool settings.

See Also:

Constant Field Values

TOOLPROXYBINDING_CUSTOM_URL

public static final String TOOLPROXYBINDING_CUSTOM_URL

TOOLPROXYBINDING_CUSTOM_URL The endpoint URL for accessing context-level tool settings.

See Also:

Constant Field Values

USER_ID

public static final String USER_ID

USER_ID Corresponds to the user_id launch parameterfrom the LaunchMixin class. This is the local identifier for the user within the Tool Consumer system.

See Also:

Constant Field Values

USER_IMAGE

public static final String USER_IMAGE

USER_IMAGE The URL for an image of the user suitable for use as a profile picture or avatar.

See Also:

Constant Field Values

USER_ORG

public static final String USER_ORG

USER_ORG A URI describing the user's organisational properties; for example, an ldap:// URI such as ldap://host.com:6666/uid=user,ou=people,dc=e xample,dc=com. If more than one format of organisational URI is specified, each should be separated with a space.

See Also:

Constant Field Values

USER_USERNAME

public static final String USER_USERNAME

USER_USERNAME The username that identifies the user within the Tool Consumer system.

See Also:

Constant Field Values

MESSAGE_LOCALE

public static final String MESSAGE_LOCALE

MESSAGE_LOCALE The locale of this launch

See Also:

Constant Field Values

ALL_VARIABLES

public static final String[] ALL_VARIABLES

ALL_VARIABLES - A list of all of the subsitution variables

Constructor Detail

LTI2Vars

public LTI2Vars()