org.oscelot.lti.tp

Class ResourceLink

java.lang.Object

org.oscelot.lti.tp.ResourceLink

public class ResourceLink
extends java.lang.Object

Class to represent an LTI resource link.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ResourceLink.Group Class to represent a group.
class	ResourceLink.GroupSet Class to represent a group set.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXT_DELETE Delete action.
static int	EXT_READ Read action.
static java.lang.String	EXT_TYPE_DECIMAL Decimal outcome type.
static java.lang.String	EXT_TYPE_LETTER_AF Letter (A-F) outcome type.
static java.lang.String	EXT_TYPE_LETTER_AF_PLUS Letter (A-F) with optional +/- outcome type.
static java.lang.String	EXT_TYPE_PASS_FAIL Pass/fail outcome type.
static java.lang.String	EXT_TYPE_PERCENTAGE Percentage outcome type.
static java.lang.String	EXT_TYPE_RATIO Ratio outcome type.
static java.lang.String	EXT_TYPE_TEXT Free text outcome type.
static int	EXT_WRITE Write (create/update) action.

Constructor Summary

Constructors

Constructor and Description
ResourceLink(ToolConsumer consumer, java.lang.String id) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete() Delete the resource link from the database.
java.util.List<User>	doMembershipsService(boolean withGroups) Perform a Memberships service request.
boolean	doOutcomesService(int action, Outcome ltiOutcome) Deprecated. use doOutcomesService(int, Outcome, User) instead. Perform an Outcomes service request. The action type parameter should be one of the pre-defined constants.
boolean	doOutcomesService(int action, Outcome ltiOutcome, User user) Perform an Outcomes service request.
java.lang.String	doSettingService(int action) Perform a Setting service request.
boolean	doSettingService(int action, java.lang.String value) Perform a Setting service request.
ToolConsumer	getConsumer() Returns the tool consumer for this resource link.
java.util.Calendar	getCreated() Returns the date/time when this resource link was created.
org.jdom.Document	getExtDoc() Returns the XML document for the last service response.
java.lang.String	getExtRequest() Returns the content of the last service request.
java.lang.String	getExtResponse() Returns the content of the last service response.
java.util.Map<java.lang.String,ResourceLink.Group>	getGroups() Returns the groups for the resource link.
java.util.Map<java.lang.String,ResourceLink.GroupSet>	getGroupSets() Returns the group sets for the resource link.
java.lang.String	getId() Returns the resource link ID.
java.lang.String	getKey() Returns the tool consumer key for this resource link.
java.lang.String	getLtiContextId() Returns the context ID for the resource link.
java.lang.String	getLtiResourceLinkId() Returns the resource link ID provided by the tool consumer on launch.
java.lang.String	getPrimaryConsumerKey() Returns the consumer key for the resource link with which this resource link is shared.
java.lang.String	getPrimaryResourceLinkId() Returns the resource link ID for the resource link with which this resource link is shared.
java.lang.String	getSetting(java.lang.String name) Returns a named setting value.
java.lang.String	getSetting(java.lang.String name, java.lang.String defaultValue) Returns a named setting value or the specified default value if the setting does not exist.
java.util.Map<java.lang.String,java.lang.String>	getSettings() Returns a map of all setting values.
java.lang.Boolean	getShareApproved() Returns true if the share with another resource link has been approved.
java.util.List<ResourceLinkShare>	getShares() Returns a list of ResourceLinkShare objects for each resource link which is sharing this resource link.
java.lang.String	getTitle() Returns the resource link title.
java.util.Calendar	getUpdated() Returns the date/time when this resource link was last updated.
java.util.Map<java.lang.String,User>	getUserResultSourcedIDs(boolean localOnly, int idScope) Returns a map of User objects for users with a result sourcedId.
boolean	hasMembershipsService() Returns true if the Memberships service is supported for the resource link.
boolean	hasOutcomesService() Returns true if the Outcomes service is supported for the resource link (either the LTI 1.1 or extension service).
boolean	hasSettingService() Returns true if the Setting service is supported for the resource link.
void	initialise() Initialise the resource link properties.
boolean	save() Save the resource link to the database.
boolean	saveSettings() Save setting values.
void	setCreated(java.util.Calendar created) Set the date/time when the resource link was created.
void	setLtiContextId(java.lang.String ltiContextId) Set the context ID for the resource link.
void	setLtiResourceLinkId(java.lang.String ltiResourceLinkId) Set the resource link ID provided by the tool consumer on launch.
void	setPrimaryConsumerKey(java.lang.String primaryConsumerKey) Set the consumer key for the resource link with which this resource link is shared.
void	setPrimaryResourceLinkId(java.lang.String primaryResourceLinkId) Set the resource link ID for the resource link with which this resource link is shared.
void	setSetting(java.lang.String name, java.lang.String value) Set a setting value with a specified name.
void	setSettings(java.util.Map<java.lang.String,java.lang.String> settings) Sets setting values to the specified map.
void	setShareApproved(java.lang.Boolean shareApproved) Set whether the sharing arrangement is approved (active).
void	setTitle(java.lang.String title) Set the resource link title.
void	setUpdated(java.util.Calendar updated) Set the date/time when the resource link was last updated.
java.lang.String	toString() Returns a string representation of this resource link.

Methods inherited from class java.lang.Object

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

Field Detail

EXT_READ

public static final int EXT_READ

Read action.

See Also:

Constant Field Values

EXT_WRITE

public static final int EXT_WRITE

Write (create/update) action.

See Also:

Constant Field Values

EXT_DELETE

public static final int EXT_DELETE

Delete action.

See Also:

Constant Field Values

EXT_TYPE_DECIMAL

public static final java.lang.String EXT_TYPE_DECIMAL

Decimal outcome type.

See Also:

Constant Field Values

EXT_TYPE_PERCENTAGE

public static final java.lang.String EXT_TYPE_PERCENTAGE

Percentage outcome type.

See Also:

Constant Field Values

EXT_TYPE_RATIO

public static final java.lang.String EXT_TYPE_RATIO

Ratio outcome type.

See Also:

Constant Field Values

EXT_TYPE_LETTER_AF

public static final java.lang.String EXT_TYPE_LETTER_AF

Letter (A-F) outcome type.

See Also:

Constant Field Values

EXT_TYPE_LETTER_AF_PLUS

public static final java.lang.String EXT_TYPE_LETTER_AF_PLUS

Letter (A-F) with optional +/- outcome type.

See Also:

Constant Field Values

EXT_TYPE_PASS_FAIL

public static final java.lang.String EXT_TYPE_PASS_FAIL

Pass/fail outcome type.

See Also:

Constant Field Values

EXT_TYPE_TEXT

public static final java.lang.String EXT_TYPE_TEXT

Free text outcome type.

See Also:

Constant Field Values

Constructor Detail

ResourceLink

public ResourceLink(ToolConsumer consumer,
            java.lang.String id)

Class constructor.

Parameters:

consumer - Consumer key value

id - Resource link ID value

Method Detail

initialise

public final void initialise()

Initialise the resource link properties.

save

public boolean save()

Save the resource link to the database.

Returns:

true if the resource link was successfully saved.

delete

public boolean delete()

Delete the resource link from the database.

Returns:

true if the resource link was successfully deleted.

getConsumer

public ToolConsumer getConsumer()

Returns the tool consumer for this resource link.

Returns:

ToolConsumer object

getKey

public java.lang.String getKey()

Returns the tool consumer key for this resource link.

Returns:

Consumer key value

getId

public java.lang.String getId()

Returns the resource link ID.

Returns:

resource link ID

getTitle

public java.lang.String getTitle()

Returns the resource link title.

Returns:

title

setTitle

public void setTitle(java.lang.String title)

Set the resource link title.

Parameters:

title - resource link title

getLtiContextId

public java.lang.String getLtiContextId()

Returns the context ID for the resource link.

Returns:

context ID

setLtiContextId

public void setLtiContextId(java.lang.String ltiContextId)

Set the context ID for the resource link.

Parameters:

ltiContextId - context ID

getLtiResourceLinkId

public java.lang.String getLtiResourceLinkId()

Returns the resource link ID provided by the tool consumer on launch.

Returns:

LTI resource link ID

setLtiResourceLinkId

public void setLtiResourceLinkId(java.lang.String ltiResourceLinkId)

Set the resource link ID provided by the tool consumer on launch.

Parameters:

ltiResourceLinkId - LTI resource link ID

getGroupSets

public java.util.Map<java.lang.String,ResourceLink.GroupSet> getGroupSets()

Returns the group sets for the resource link.

Returns:

map of group sets with group set ID as key

getGroups

public java.util.Map<java.lang.String,ResourceLink.Group> getGroups()

Returns the groups for the resource link.

Returns:

map of groups with group ID as key

getExtRequest

public java.lang.String getExtRequest()

Returns the content of the last service request.

Returns:

request content

getExtResponse

public java.lang.String getExtResponse()

Returns the content of the last service response.

Returns:

response content

getExtDoc

public org.jdom.Document getExtDoc()

Returns the XML document for the last service response.

Returns:

XML document

getPrimaryConsumerKey

public java.lang.String getPrimaryConsumerKey()

Returns the consumer key for the resource link with which this resource link is shared.

Returns:

consumer key

setPrimaryConsumerKey

public void setPrimaryConsumerKey(java.lang.String primaryConsumerKey)

Set the consumer key for the resource link with which this resource link is shared.

Parameters:

primaryConsumerKey - consumer key

getPrimaryResourceLinkId

public java.lang.String getPrimaryResourceLinkId()

Returns the resource link ID for the resource link with which this resource link is shared.

Returns:

resource link ID

setPrimaryResourceLinkId

public void setPrimaryResourceLinkId(java.lang.String primaryResourceLinkId)

Set the resource link ID for the resource link with which this resource link is shared.

Parameters:

primaryResourceLinkId - resource link ID

getShareApproved

public java.lang.Boolean getShareApproved()

Returns true if the share with another resource link has been approved.

If no sharing arrangement has been set up this property should have a value of null.

Returns:

true if a sharing arrangement is active

setShareApproved

public void setShareApproved(java.lang.Boolean shareApproved)

Set whether the sharing arrangement is approved (active).

This value should be null if no arrangement is in place.

Parameters:

shareApproved - true if the resource link is shared

getSetting

public java.lang.String getSetting(java.lang.String name)

Returns a named setting value.

Parameters:

name - name of setting

Returns:

setting value (or an empty string if it does not exist)

getSetting

public java.lang.String getSetting(java.lang.String name,
                          java.lang.String defaultValue)

Returns a named setting value or the specified default value if the setting does not exist.

Parameters:

name - name of setting

defaultValue - value to return if the setting does not exist

Returns:

setting value

setSetting

public void setSetting(java.lang.String name,
              java.lang.String value)

Set a setting value with a specified name.

Parameters:

name - name of setting

value - value to set, use an empty or null value to delete a setting

getSettings

public java.util.Map<java.lang.String,java.lang.String> getSettings()

Returns a map of all setting values.

Returns:

Map of setting values

setSettings

public void setSettings(java.util.Map<java.lang.String,java.lang.String> settings)

Sets setting values to the specified map.

Parameters:

settings - map of setting values

saveSettings

public boolean saveSettings()

Save setting values.

Returns:

true if the settings were successfully saved

hasOutcomesService

public boolean hasOutcomesService()

Returns true if the Outcomes service is supported for the resource link (either the LTI 1.1 or extension service).

Returns:

true if Outcomes service is supported

hasMembershipsService

public boolean hasMembershipsService()

Returns true if the Memberships service is supported for the resource link.

Returns:

true if Memberships service is supported

hasSettingService

public boolean hasSettingService()

Returns true if the Setting service is supported for the resource link.

Returns:

true if the Setting service is supported

doOutcomesService

@Deprecated
public boolean doOutcomesService(int action,
                                   Outcome ltiOutcome)

Deprecated. use doOutcomesService(int, Outcome, User) instead.

Perform an Outcomes service request.

The action type parameter should be one of the pre-defined constants.

Parameters:

action - action type

ltiOutcome - Outcome object

Returns:

true if the request was successfully processed

See Also:

EXT_READ, EXT_WRITE, EXT_DELETE

doOutcomesService

public boolean doOutcomesService(int action,
                        Outcome ltiOutcome,
                        User user)

Perform an Outcomes service request.

The action type parameter should be one of the pre-defined constants.

Parameters:

action - action type

ltiOutcome - Outcome object

user - User object

Returns:

true if the request was successfully processed

See Also:

EXT_READ, EXT_WRITE, EXT_DELETE

doMembershipsService

public java.util.List<User> doMembershipsService(boolean withGroups)

Perform a Memberships service request.

The user table is updated with the new list of user objects. If the groups enhancement is not supported for the resource link, then only membership data will be returned.

Parameters:

withGroups - true if group information should also be requested

Returns:

list of User objects

doSettingService

public java.lang.String doSettingService(int action)

Perform a Setting service request.

The current setting value can also be read by using getSetting("ext_ims_lti_tool_setting")

Parameters:

action - action type

Returns:

current setting value, null if an error occurs

See Also:

EXT_READ, EXT_DELETE, doSettingService(int,String), getSetting(String)

doSettingService

public boolean doSettingService(int action,
                       java.lang.String value)

Perform a Setting service request.

Parameters:

action - action type

value - setting value (for write actions)

Returns:

true the action was successful

See Also:

EXT_READ, EXT_WRITE, EXT_DELETE, doSettingService(int)

getUserResultSourcedIDs

public java.util.Map<java.lang.String,User> getUserResultSourcedIDs(boolean localOnly,
                                                           int idScope)

Returns a map of User objects for users with a result sourcedId.

The array may include users from other contexts which are sharing this resource link. It uses the user ID of the specified scope as the key.

Parameters:

localOnly - true if only users from the resource link are to be returned, not users from shared contexts

idScope - scope to use for ID values

Returns:

map of User objects

getShares

public java.util.List<ResourceLinkShare> getShares()

Returns a list of ResourceLinkShare objects for each resource link which is sharing this resource link.

Returns:

list of ResourceLinkShare objects

getCreated

public java.util.Calendar getCreated()

Returns the date/time when this resource link was created.

Returns:

date/time of creation

setCreated

public void setCreated(java.util.Calendar created)

Set the date/time when the resource link was created.

Parameters:

created - date/time of creation

getUpdated

public java.util.Calendar getUpdated()

Returns the date/time when this resource link was last updated.

Returns:

date/time of last update

setUpdated

public void setUpdated(java.util.Calendar updated)

Set the date/time when the resource link was last updated.

Parameters:

updated - date/time of last update

toString

public java.lang.String toString()

Returns a string representation of this resource link.

The string representation consists of the resource link ID, title, group sets, groups and settings.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this resource link