|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object pt.digitalis.dif.controller.objects.DIFContext
public class DIFContext
This class is the base class for the DIF execution context.
Field Summary | |
---|---|
protected ViewObject |
theView
The ViewObject. |
Constructor Summary | |
---|---|
DIFContext()
|
Method Summary | |
---|---|
void |
addResultMessage(String type,
String title,
String description)
Adds a result message to the stage result |
void |
addResultMessage(String type,
String title,
String description,
boolean popupMode)
Adds a result message to the stage result |
void |
addResultMessage(String type,
String title,
String description,
String mode)
Adds a result message to the stage result. |
void |
addStageResult(String resultName,
Object resultValue)
Add a new result to the stage results. |
String |
getLanguage()
|
IDIFRequest |
getRequest()
Inspector for the DIFRequest object |
ResultMessage |
getResultMessage()
Inspector for the 'resultMessage' attribute. |
IDIFSession |
getSession()
Inspector for the session object. |
String |
getStage()
Inspector for the current stage |
Map<String,Object> |
getStageResults()
Inspector for the stage results. |
Map<String,Object> |
getTemporaryAttributes()
Inspector for the 'temporaryAttributes' attribute. |
ViewObject |
getView()
Inspector for the view. |
void |
handleRedirection()
This method sets the current stage equal to the redirection stage. |
boolean |
hasRedirection()
Inspector for the redirection flag. |
void |
redirectTo(String newStage)
Sets the redirection stage. |
void |
redirectTo(String newStage,
boolean allowRedirectToSameStage)
Sets the redirection stage. |
void |
redirectTo(String newStage,
Map<String,Object> redirectionParameters)
Sets the redirection stage. |
void |
redirectTo(String newStage,
Map<String,Object> redirectionParameters,
boolean allowRedirectToSameStage)
Sets the redirection stage. |
void |
redirectTo(String newStage,
String redirectionParameters)
Sets the redirection stage. |
void |
redirectTo(String newStage,
String redirectionParameters,
boolean allowRedirectToSameStage)
Sets the redirection stage. |
void |
reportIssue(String uID,
IssueType type,
String issueDescription)
Report an issue to the IUsageIssuesManager |
void |
reportIssue(String uID,
IssueType type,
String issueDescription,
Exception exception)
Report an issue to the IUsageIssuesManager |
void |
reportIssue(String uID,
IssueType type,
String issueDescription,
Exception exception,
boolean showStackTrace)
Report an issue to the IUsageIssuesManager |
void |
reportIssue(UsageIssue issue)
Report an issue to the IUsageIssuesManager |
void |
setRequest(IDIFRequest difRequest)
Modifier for the DIFRequest Object |
void |
setSession(IDIFSession session)
Modifier for the session object. |
void |
setStage(String stage)
Modifier for the current stage |
void |
setStageResults(Map<String,Object> results)
Modifier for the stage results. |
void |
setTemporaryAttributes(Map<String,Object> temporaryAttributes)
Modifier for the 'temporaryAttributes' attribute. |
void |
setView(ViewObject newView)
Modifier for the view. |
String |
toString()
Prints the context information on an human-readable form. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected ViewObject theView
Constructor Detail |
---|
public DIFContext()
Method Detail |
---|
public void addResultMessage(String type, String title, String description)
IDIFContext
addResultMessage
in interface IDIFContext
type
- the message typetitle
- the title of the messagedescription
- the description of the messageIDIFContext.addResultMessage(java.lang.String, java.lang.String,
java.lang.String)
public void addResultMessage(String type, String title, String description, boolean popupMode)
IDIFContext
addResultMessage
in interface IDIFContext
type
- the message typetitle
- the title of the messagedescription
- the description of the messagepopupMode
- if the message should be showed in popup mode (in a dialog)IDIFContext.addResultMessage(java.lang.String, java.lang.String,
java.lang.String, boolean)
public void addResultMessage(String type, String title, String description, String mode)
IDIFContext
addResultMessage
in interface IDIFContext
type
- the message typetitle
- the title of the messagedescription
- the description of the messagemode
- the modeIDIFContext.addResultMessage(java.lang.String, java.lang.String,
java.lang.String, java.lang.String)
public void addStageResult(String resultName, Object resultValue)
IDIFContext
addStageResult
in interface IDIFContext
resultName
- the name of the resultresultValue
- the result valueIDIFContext.addStageResult(String, Object)
public String getLanguage()
getLanguage
in interface IDIFContext
IDIFContext.getLanguage()
public IDIFRequest getRequest()
IDIFContext
getRequest
in interface IDIFContext
IDIFContext.getRequest()
public ResultMessage getResultMessage()
IDIFContext
getResultMessage
in interface IDIFContext
IDIFContext.getResultMessage()
public IDIFSession getSession()
IDIFContext
getSession
in interface IDIFContext
IDIFContext.getSession()
public String getStage()
IDIFContext
getStage
in interface IDIFContext
IDIFContext.getStage()
public final Map<String,Object> getStageResults()
IDIFContext
getStageResults
in interface IDIFContext
IDIFContext.getStageResults()
public Map<String,Object> getTemporaryAttributes()
IDIFContext
getTemporaryAttributes
in interface IDIFContext
IDIFContext.getTemporaryAttributes()
public ViewObject getView()
IDIFContext
getView
in interface IDIFContext
IDIFContext.getView()
public void handleRedirection()
handleRedirection
in interface IDIFContext
IDIFContext.handleRedirection()
public boolean hasRedirection()
IDIFContext
hasRedirection
in interface IDIFContext
IDIFContext.hasRedirection()
public void redirectTo(String newStage)
IDIFContext
redirectTo
in interface IDIFContext
newStage
- the stage to redirect toIDIFContext.redirectTo(java.lang.String)
public void redirectTo(String newStage, boolean allowRedirectToSameStage)
IDIFContext
redirectTo
in interface IDIFContext
newStage
- the stage to redirect toallowRedirectToSameStage
- if T allows redirect to same stage to be setIDIFContext.redirectTo(java.lang.String, boolean)
public void redirectTo(String newStage, Map<String,Object> redirectionParameters)
IDIFContext
redirectTo
in interface IDIFContext
newStage
- the stage to redirect toredirectionParameters
- the redirection parametersIDIFContext.redirectTo(java.lang.String, java.util.Map)
public void redirectTo(String newStage, Map<String,Object> redirectionParameters, boolean allowRedirectToSameStage)
IDIFContext
redirectTo
in interface IDIFContext
newStage
- the stage to redirect toredirectionParameters
- the redirection parametersallowRedirectToSameStage
- if T allows redirect to same stage to be setIDIFContext.redirectTo(java.lang.String, java.util.Map, boolean)
public void redirectTo(String newStage, String redirectionParameters)
IDIFContext
redirectTo
in interface IDIFContext
newStage
- the stage to redirect toredirectionParameters
- the redirection parametersIDIFContext.redirectTo(java.lang.String, java.lang.String)
public void redirectTo(String newStage, String redirectionParameters, boolean allowRedirectToSameStage)
IDIFContext
redirectTo
in interface IDIFContext
newStage
- the stage to redirect toredirectionParameters
- the redirection parametersallowRedirectToSameStage
- if T allows redirect to same stage to be setIDIFContext.redirectTo(java.lang.String, java.lang.String, boolean)
public void reportIssue(String uID, IssueType type, String issueDescription)
IDIFContext
IUsageIssuesManager
reportIssue
in interface IDIFContext
uID
- the unique identifier for this contribution. for recurring errors not to be added repeatedlytype
- the issue typeIDIFContext.reportIssue(java.lang.String,
pt.digitalis.dif.dem.objects.issues.IssueType, java.lang.String)
public void reportIssue(String uID, IssueType type, String issueDescription, Exception exception)
IDIFContext
IUsageIssuesManager
reportIssue
in interface IDIFContext
uID
- the unique identifier for this contribution. for recurring errors not to be added repeatedlytype
- the issue typeexception
- the raised exceptionIDIFContext.reportIssue(java.lang.String,
pt.digitalis.dif.dem.objects.issues.IssueType, java.lang.String, java.lang.Exception)
public void reportIssue(String uID, IssueType type, String issueDescription, Exception exception, boolean showStackTrace)
IDIFContext
IUsageIssuesManager
reportIssue
in interface IDIFContext
uID
- the unique identifier for this contribution. for recurring errors not to be added repeatedlytype
- the issue typeexception
- the raised exceptionshowStackTrace
- if the stack trace should be generated and attached to the issue descriptionIDIFContext.reportIssue(java.lang.String,
pt.digitalis.dif.dem.objects.issues.IssueType, java.lang.String, java.lang.Exception, boolean)
public void reportIssue(UsageIssue issue)
IDIFContext
IUsageIssuesManager
reportIssue
in interface IDIFContext
issue
- the issue descriptorIDIFContext.reportIssue(pt.digitalis.dif.dem.objects.issues.UsageIssue)
public void setRequest(IDIFRequest difRequest)
IDIFContext
setRequest
in interface IDIFContext
difRequest
- the Original DifRequestIDIFContext.setRequest(pt.digitalis.dif.controller.interfaces.IDIFRequest)
public void setSession(IDIFSession session)
IDIFContext
setSession
in interface IDIFContext
session
- the session to setIDIFContext.setSession(IDIFSession)
public void setStage(String stage)
IDIFContext
setStage
in interface IDIFContext
stage
- the stage to setIDIFContext.setStage(String)
public final void setStageResults(Map<String,Object> results)
IDIFContext
setStageResults
in interface IDIFContext
results
- the results to setIDIFContext.setStageResults(Map)
public void setTemporaryAttributes(Map<String,Object> temporaryAttributes)
IDIFContext
setTemporaryAttributes
in interface IDIFContext
temporaryAttributes
- the new temporaryAttributes value to setIDIFContext.setTemporaryAttributes(java.util.Map)
public void setView(ViewObject newView)
IDIFContext
setView
in interface IDIFContext
newView
- the ViewObject to setIDIFContext.setView(ViewObject)
public String toString()
toString
in class Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |