org.assistments.domain.core.actions

Class Action

java.lang.Object

org.assistments.domain.content.tutor.Persistable

org.assistments.domain.core.actions.Action

All Implemented Interfaces:

HasUID, IsPersistable, SelfValidating

Direct Known Subclasses:

ProblemAction, SetAction

public abstract class Action
extends Persistable

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	EXCLUDE_TIMESTAMP
static java.lang.String	EXTRA_DATA_DEV_CONSOLE
static java.lang.String	EXTRA_DATA_NAVIGATOR
static java.lang.String	EXTRA_DATA_TERMINATOR
protected static boolean	INCLUDE_TIMESTAMP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Action(java.lang.String subclassType, java.lang.String uid) For use by subclasses when a translator instantiates the subclass.
protected	Action(java.lang.String subclassType, java.lang.String uid, Manifest manifest)

Method Summary

Modifier and Type	Method and Description
void	addElementToExtraData(java.lang.String ownerName, java.lang.String keyName, java.lang.String value)
void	addExtraData(java.lang.String ownerName, java.util.HashMap<java.lang.String,java.lang.String> obj)
int	getAssignmentXId()
java.lang.String	getAssignmentXRef()
protected java.lang.String	getBaseFingerPrint() Returns a basic fingerprint common to all Actions.
protected java.lang.String	getBaseFingerPrint(boolean includeTimeStamp) Returns a basic fingerprint common to all Actions.
java.lang.String	getContentKey()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getExtraData()
java.util.Map<java.lang.String,java.lang.String>	getExtraData(java.lang.String owner)
abstract java.lang.String	getFingerPrint() Returns a string, based the content this action refers to, to uniquely identify this action for the purpose of determining whether actions are duplicates.
java.lang.String	getManifestKey()
java.lang.String	getNavigator()
NetworkState	getNetworkState()
java.lang.String	getPath() Returns the path of Problem Set IDs that leads to the current problem.
java.lang.String	getTerminator()
long	getTimestamp()
int	getUserXId()
java.lang.String	getUserXRef()
boolean	isForMe(Manifest m) Returns whether the provided Manifest's persistence key matches the Manifest this Action is for.
boolean	isForMe(java.lang.String mKey) Returns whether the provided Manifest persistence key matches the Manifest this Action is for.
boolean	isScaffolding()
void	modifyExtraDataElement(java.lang.String ownerName, java.lang.String keyName, java.lang.String value)
void	removeExtraDataEntry(java.lang.String ownerName)
void	setAssignmentXId(int assignmentXId)
void	setAssignmentXRef(java.lang.String assignmentXRef)
void	setContentKey(java.lang.String contentKey)
void	setExtraData(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> map)
void	setManifestKey(java.lang.String key)
void	setNavigator(java.lang.String navigator)
void	setNetworkState(NetworkState networkState)
void	setPath(java.lang.String pathInfo) Sets the path of Problem Set IDs that leads to the current problem - main problems only.
void	setScaffolding(boolean isScaffolding)
void	setTerminator(java.lang.String terminator)
void	setTimestamp(long timestamp)
void	setUserXId(int userXId)
void	setUserXRef(java.lang.String userXRef)
boolean	shouldBePersisted() Returns whether this Action should be sent to the server for logging.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class org.assistments.domain.content.tutor.Persistable

createKey, createKey, equals, extractType, extractUID, getKey, getShortKey, getShortKey, getType, getUID, getValidatorUtilities, setValidatorUtilities, validate, validateKey

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_DATA_DEV_CONSOLE

public static java.lang.String EXTRA_DATA_DEV_CONSOLE

EXTRA_DATA_TERMINATOR

public static java.lang.String EXTRA_DATA_TERMINATOR

EXTRA_DATA_NAVIGATOR

public static java.lang.String EXTRA_DATA_NAVIGATOR

INCLUDE_TIMESTAMP

protected static boolean INCLUDE_TIMESTAMP

EXCLUDE_TIMESTAMP

protected static boolean EXCLUDE_TIMESTAMP

Constructor Detail

Action

protected Action(java.lang.String subclassType,
                 java.lang.String uid,
                 Manifest manifest)

Action

protected Action(java.lang.String subclassType,
                 java.lang.String uid)

For use by subclasses when a translator instantiates the subclass.

Parameters:

uid -

Method Detail

setTimestamp

public void setTimestamp(long timestamp)

getTimestamp

public long getTimestamp()

setManifestKey

public void setManifestKey(java.lang.String key)

getManifestKey

public java.lang.String getManifestKey()

setNavigator

public void setNavigator(java.lang.String navigator)

getNavigator

public java.lang.String getNavigator()

setTerminator

public void setTerminator(java.lang.String terminator)

getTerminator

public java.lang.String getTerminator()

isForMe

public boolean isForMe(java.lang.String mKey)

Returns whether the provided Manifest persistence key matches the Manifest this Action is for.

Parameters:

mKey - Manifest persistence key to match with the Action's Manifest persistence key.

Returns:

true if the key's match; otherwise false.

See Also:

isForMe(Manifest)

isForMe

public boolean isForMe(Manifest m)

Returns whether the provided Manifest's persistence key matches the Manifest this Action is for. This is a convenience method for isForMe(String).

Parameters:

m - Manifest to match with the Action's Manifest.

Returns:

true if the key's match; otherwise false.

See Also:

isForMe(String)

setContentKey

public void setContentKey(java.lang.String contentKey)

getContentKey

public java.lang.String getContentKey()

isScaffolding

public boolean isScaffolding()

setScaffolding

public void setScaffolding(boolean isScaffolding)

getNetworkState

public NetworkState getNetworkState()

setNetworkState

public void setNetworkState(NetworkState networkState)

setPath

public void setPath(java.lang.String pathInfo)

Sets the path of Problem Set IDs that leads to the current problem - main problems only. Scaffolding not included in the path.

Parameters:

pathInfo - Path of Problem Set IDs

See Also:

getPath()

getPath

public java.lang.String getPath()

Returns the path of Problem Set IDs that leads to the current problem.

See Also:

setPath(String)

getUserXId

public int getUserXId()

setUserXId

public void setUserXId(int userXId)

getUserXRef

public java.lang.String getUserXRef()

setUserXRef

public void setUserXRef(java.lang.String userXRef)

getAssignmentXId

public int getAssignmentXId()

setAssignmentXId

public void setAssignmentXId(int assignmentXId)

getAssignmentXRef

public java.lang.String getAssignmentXRef()

setAssignmentXRef

public void setAssignmentXRef(java.lang.String assignmentXRef)

shouldBePersisted

public boolean shouldBePersisted()

Returns whether this Action should be sent to the server for logging. Assumes that by default all Actions are logged. If you have an action you do not want logged, override and return false.

getFingerPrint

public abstract java.lang.String getFingerPrint()

Returns a string, based the content this action refers to, to uniquely identify this action for the purpose of determining whether actions are duplicates.

Subclasses must override this base implementation when if fact multiple instances of an Action are expected and acceptable. For example: While there should be one and only one user response with a correct answer, there can be multiple incorrect user responses.

The each subclass can choose to overwrite or modify the return finger print string to reflect its own semantics of uniqueness.

Returns:

Action-specific finger print string

getBaseFingerPrint

protected java.lang.String getBaseFingerPrint(boolean includeTimeStamp)

Returns a basic fingerprint common to all Actions.

Parameters:

includeTimeStamp - true to include the action's the timestamp; false to exclude the action's the timestamp.

See Also:

getBaseFingerPrint()

getBaseFingerPrint

protected java.lang.String getBaseFingerPrint()

Returns a basic fingerprint common to all Actions. Does not include the action's timestamp.

See Also:

getBaseFingerPrint(boolean)

toString

public java.lang.String toString()

Description copied from class: Persistable

Returns a string representation of this object.

Specified by:

toString in interface IsPersistable

Overrides:

toString in class Persistable

setExtraData

public void setExtraData(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> map)

addExtraData

public void addExtraData(java.lang.String ownerName,
                         java.util.HashMap<java.lang.String,java.lang.String> obj)

addElementToExtraData

public void addElementToExtraData(java.lang.String ownerName,
                                  java.lang.String keyName,
                                  java.lang.String value)

modifyExtraDataElement

public void modifyExtraDataElement(java.lang.String ownerName,
                                   java.lang.String keyName,
                                   java.lang.String value)

removeExtraDataEntry

public void removeExtraDataEntry(java.lang.String ownerName)

getExtraData

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

getExtraData

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