org.oscelot.lti.tp

Class ToolConsumer

java.lang.Object

org.oscelot.lti.tp.ToolConsumer

public class ToolConsumer
extends java.lang.Object

Class to represent an LTI User.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Constructor Summary

Constructors

Constructor and Description
ToolConsumer(java.lang.String key, DataConnector dataConnector, boolean autoEnable) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete() Delete the tool consumer from the database.
java.lang.String	getConsumerGUID()
java.lang.String	getConsumerName()
java.lang.String	getConsumerVersion()
java.util.Calendar	getCreated()
java.lang.String	getCssPath()
DataConnector	getDataConnector() Get the data connector.
java.lang.String	getDefaultEmail()
java.util.Calendar	getEnableFrom()
java.util.Calendar	getEnableUntil()
int	getIdScope()
java.lang.String	getKey() Get the tool consumer key.
java.util.Calendar	getLastAccess()
java.lang.String	getLtiVersion()
java.lang.String	getName()
java.lang.String	getSecret()
java.util.Calendar	getUpdated()
void	initialise() Initialise the tool consumer.
boolean	isAvailable() Is the consumer key available to accept launch requests?
boolean	isEnabled()
boolean	isProtect()
boolean	save() Save the tool consumer to the database.
void	setConsumerGUID(java.lang.String consumerGUID)
void	setConsumerName(java.lang.String consumerName)
void	setConsumerVersion(java.lang.String consumerVersion)
void	setCreated(java.util.Calendar created)
void	setCssPath(java.lang.String cssPath)
void	setDefaultEmail(java.lang.String defaultEmail)
void	setEnabled(boolean enabled)
void	setEnableFrom(java.util.Calendar enableFrom)
void	setEnableUntil(java.util.Calendar enableUntil)
void	setLastAccess(java.util.Calendar lastAccess)
void	setLtiVersion(java.lang.String ltiVersion)
void	setName(java.lang.String name)
void	setProtect(boolean protect)
void	setSecret(java.lang.String secret)
void	setUpdated(java.util.Calendar updated)

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolConsumer

public ToolConsumer(java.lang.String key,
            DataConnector dataConnector,
            boolean autoEnable)

Class constructor.

Parameters:

key - consumer key

dataConnector - data connection object

autoEnable - true if the tool consumers is to be enabled automatically

Method Detail

initialise

public void initialise()

Initialise the tool consumer.

save

public boolean save()

Save the tool consumer to the database.

Returns:

boolean True if the object was successfully saved

delete

public boolean delete()

Delete the tool consumer from the database.

Returns:

boolean True if the object was successfully deleted

getKey

public java.lang.String getKey()

Get the tool consumer key.

Returns:

string Consumer key value

getConsumerGUID

public java.lang.String getConsumerGUID()

setConsumerGUID

public void setConsumerGUID(java.lang.String consumerGUID)

getConsumerName

public java.lang.String getConsumerName()

setConsumerName

public void setConsumerName(java.lang.String consumerName)

getConsumerVersion

public java.lang.String getConsumerVersion()

setConsumerVersion

public void setConsumerVersion(java.lang.String consumerVersion)

getCssPath

public java.lang.String getCssPath()

setCssPath

public void setCssPath(java.lang.String cssPath)

getDefaultEmail

public java.lang.String getDefaultEmail()

setDefaultEmail

public void setDefaultEmail(java.lang.String defaultEmail)

getEnableFrom

public java.util.Calendar getEnableFrom()

setEnableFrom

public void setEnableFrom(java.util.Calendar enableFrom)

getEnableUntil

public java.util.Calendar getEnableUntil()

setEnableUntil

public void setEnableUntil(java.util.Calendar enableUntil)

isProtect

public boolean isProtect()

setProtect

public void setProtect(boolean protect)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getIdScope

public int getIdScope()

getLastAccess

public java.util.Calendar getLastAccess()

setLastAccess

public void setLastAccess(java.util.Calendar lastAccess)

getLtiVersion

public java.lang.String getLtiVersion()

setLtiVersion

public void setLtiVersion(java.lang.String ltiVersion)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getSecret

public java.lang.String getSecret()

setSecret

public void setSecret(java.lang.String secret)

getCreated

public java.util.Calendar getCreated()

setCreated

public void setCreated(java.util.Calendar created)

getUpdated

public java.util.Calendar getUpdated()

setUpdated

public void setUpdated(java.util.Calendar updated)

getDataConnector

public DataConnector getDataConnector()

Get the data connector.

Returns:

mixed Data connector object or string

isAvailable

public boolean isAvailable()

Is the consumer key available to accept launch requests?

Returns:

boolean True if the consumer key is enabled and within any date constraints