org.oscelot.lti.tp

Class Outcome

java.lang.Object

org.oscelot.lti.tp.Outcome

public class Outcome
extends java.lang.Object

Class to represent an LTI Outcome.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Constructor Summary

Constructors

Constructor and Description
Outcome() Construct an empty outcome object.
Outcome(java.lang.String value) Construct an outcome object using the specified value.
Outcome(java.lang.String sourcedId, java.lang.String value) Deprecated. use Outcome(String) instead. Construct an outcome object using the specified sourcedId and value. The language defaults to en-US, and a type of decimal and the current date/time are used.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDataSource() Returns the data source.
java.lang.String	getDate() Returns the date.
java.lang.String	getLanguage() Returns the language.
java.lang.String	getSourcedId() Deprecated. Use property from User object instead Returns the result sourcedId value.
java.lang.String	getStatus() Returns the status.
java.lang.String	getType() Returns the type.
java.lang.String	getValue() Get the outcome value.
void	setType(java.lang.String type) Set the type.
void	setValue(java.lang.String value) Set the outcome value.
java.lang.String	toString() Returns a string representation of this outcome.

Methods inherited from class java.lang.Object

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

Constructor Detail

Outcome

public Outcome()

Construct an empty outcome object.

The language defaults to en-US, and a type of decimal and the current date/time are used.

Outcome

public Outcome(java.lang.String value)

Construct an outcome object using the specified value.

The language defaults to en-US, and a type of decimal and the current date/time are used.

Parameters:

value - outcome value, may be null

Outcome

@Deprecated
public Outcome(java.lang.String sourcedId,
                  java.lang.String value)

Deprecated. use Outcome(String) instead.

Construct an outcome object using the specified sourcedId and value.

The language defaults to en-US, and a type of decimal and the current date/time are used.

Parameters:

sourcedId - sourcedId value for the user/context

value - outcome value, may be null

Method Detail

getType

public java.lang.String getType()

Returns the type.

Returns:

type

setType

public void setType(java.lang.String type)

Set the type.

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

Parameters:

type - Outcome value

See Also:

ResourceLink.EXT_TYPE_DECIMAL, ResourceLink.EXT_TYPE_PERCENTAGE, ResourceLink.EXT_TYPE_RATIO, ResourceLink.EXT_TYPE_LETTER_AF, ResourceLink.EXT_TYPE_LETTER_AF_PLUS, ResourceLink.EXT_TYPE_PASS_FAIL, ResourceLink.EXT_TYPE_TEXT

getSourcedId

@Deprecated
public java.lang.String getSourcedId()

Deprecated. Use property from User object instead Returns the result sourcedId value.

Returns:

result sourcedId value

getValue

public java.lang.String getValue()

Get the outcome value.

Returns:

string Outcome value

setValue

public void setValue(java.lang.String value)

Set the outcome value.

Parameters:

value - Outcome value

getLanguage

public java.lang.String getLanguage()

Returns the language.

Returns:

language

getStatus

public java.lang.String getStatus()

Returns the status.

Returns:

status

getDate

public java.lang.String getDate()

Returns the date.

Returns:

date

getDataSource

public java.lang.String getDataSource()

Returns the data source.

Returns:

data source

toString

public java.lang.String toString()

Returns a string representation of this outcome.

The string representation consists of the outcome's type and value.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this outcome