public final class ToolMessage extends Message
ATTEMPT, CONTEXT_MSG_ELEMENT, CURRICULUM_MSG_ELEMENT, HINT_MESSAGE, HINT_REQUEST, MSG_ELEMENT, MSG_SEQUENCE_ELEMENT, RESULT, TOOL_MSG_ELEMENT, TUTOR_MSG_ELEMENT, VERSION_NUMBER, VERSION_NUMBER_ATTR
Modifier and Type | Method and Description |
---|---|
void |
addAction(java.lang.String action)
Add action to event descriptor element.
|
void |
addCustomField(CustomFieldElement customFieldElement)
Add custom field given the custom field element.
|
void |
addCustomField(java.lang.String name,
java.lang.String value)
Add custom field given the name and value.
|
void |
addInput(java.lang.String input)
Add input to event descriptor element.
|
void |
addSai(java.lang.String selection,
java.lang.String action,
java.lang.String input)
Add selection, action, and input.
|
void |
addSelection(java.lang.String selection)
Add selection to event descriptor element.
|
static ToolMessage |
create(ContextMessage contextMessage)
Creates a new tool message given a context message.
|
java.util.List |
getCustomFieldList()
Get custom field list.
|
EventDescriptorElement |
getEventDescriptorElement()
Get event descriptor element.
|
EventElement |
getEventElement()
Get event element.
|
java.lang.String |
getProblemName()
Get problem name.
|
java.lang.String |
getReplayText()
Get replay text.
|
void |
setAsAttempt()
Set event as an attempt event.
|
void |
setAsAttempt(java.lang.String subtype)
Set event as an attempt event given the subtype.
|
void |
setAsHintRequest()
Set event as hint request.
|
void |
setAsHintRequest(java.lang.String subtype)
Set event as hint request given the subtype.
|
void |
setEventElement(EventElement eventElement)
Set event element.
|
void |
setProblemName(java.lang.String problemName)
Set problem name.
|
void |
setReplayElement(java.lang.String replayText)
Set replay text.
|
void |
setTransactionId(java.lang.String id)
Set transaction id.
|
java.lang.String |
toString()
To string method calls toString(boolean).
|
java.lang.String |
toString(boolean logMetaFlag)
To string method.
|
generateGUID, getContextMessageId, getMetaElement, getSessionId, getSource, getTimeString, getTimeZone, getUserId, setContextMessageId, setSource, setTimeString
public static ToolMessage create(ContextMessage contextMessage)
contextMessage
- the context messagepublic java.lang.String getProblemName()
public void setProblemName(java.lang.String problemName)
problemName
- the problem namepublic EventElement getEventElement()
public void setEventElement(EventElement eventElement)
eventElement
- the event elementpublic void setAsAttempt()
public void setAsAttempt(java.lang.String subtype)
subtype
- a subtypepublic void setAsHintRequest()
public void setAsHintRequest(java.lang.String subtype)
subtype
- the subtypepublic EventDescriptorElement getEventDescriptorElement()
public void addSai(java.lang.String selection, java.lang.String action, java.lang.String input)
selection
- the selectionaction
- the actioninput
- the inputpublic void addSelection(java.lang.String selection)
selection
- the selectionpublic void addAction(java.lang.String action)
action
- the actionpublic void addInput(java.lang.String input)
input
- the inputpublic java.util.List getCustomFieldList()
public void addCustomField(java.lang.String name, java.lang.String value)
name
- the namevalue
- the valuepublic void addCustomField(CustomFieldElement customFieldElement)
customFieldElement
- the custom field elementpublic void setTransactionId(java.lang.String id)
id
- the transaction idpublic java.lang.String getReplayText()
public void setReplayElement(java.lang.String replayText)
replayText
- the replay textpublic java.lang.String toString()
toString
in class java.lang.Object
Copyright (c) 2015 - Pittsburgh Science of Learning Center