pt.digitalis.dif.controller.interfaces
Interface IDIFContext

All Known Implementing Classes:

DIFContext

public interface IDIFContext

This interface hides some DIFContext details from the Stage. There are public setters on the DIFContext class that would be accessible to the Stage.

Author:

Rodrigo Gonçalves rgoncalves@digitalis.pt

Created on:

2007/04/20

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() Handles the redirection.
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 view) Modifier for the view.

Method Detail

addResultMessage

void addResultMessage(String type,
                      String title,
                      String description)

Adds a result message to the stage result

Parameters:

type - the message type

title - the title of the message

description - the description of the message

addResultMessage

void addResultMessage(String type,
                      String title,
                      String description,
                      boolean popupMode)

Adds a result message to the stage result

Parameters:

type - the message type

title - the title of the message

description - the description of the message

popupMode - if the message should be showed in popup mode (in a dialog)

addResultMessage

void addResultMessage(String type,
                      String title,
                      String description,
                      String mode)

Adds a result message to the stage result.

Parameters:

type - the message type

title - the title of the message

description - the description of the message

mode - the mode

addStageResult

void addStageResult(String resultName,
                    Object resultValue)

Add a new result to the stage results.

Parameters:

resultName - the name of the result

resultValue - the result value

getLanguage

String getLanguage()

Returns:

the language of the current context

getRequest

IDIFRequest getRequest()

Inspector for the DIFRequest object

Returns:

the IDIFRequest

getResultMessage

ResultMessage getResultMessage()

Inspector for the 'resultMessage' attribute.

Returns:

the resultMessage value

getSession

IDIFSession getSession()

Inspector for the session object.

Returns:

the session

getStage

String getStage()

Inspector for the current stage

Returns:

the current stage

getStageResults

Map<String,Object> getStageResults()

Inspector for the stage results.

Returns:

the stage results map

getTemporaryAttributes

Map<String,Object> getTemporaryAttributes()

Inspector for the 'temporaryAttributes' attribute.

Returns:

the temporaryAttributes value

getView

ViewObject getView()

Inspector for the view.

Returns:

the ViewObject.

handleRedirection

void handleRedirection()

Handles the redirection.

hasRedirection

boolean hasRedirection()

Inspector for the redirection flag.

Returns:

T if redirection is scheduled, F otherwise

redirectTo

void redirectTo(String newStage)

Sets the redirection stage.

Parameters:

newStage - the stage to redirect to

redirectTo

void redirectTo(String newStage,
                boolean allowRedirectToSameStage)

Sets the redirection stage.

Parameters:

newStage - the stage to redirect to

allowRedirectToSameStage - if T allows redirect to same stage to be set

redirectTo

void redirectTo(String newStage,
                Map<String,Object> redirectionParameters)

Sets the redirection stage.

Parameters:

newStage - the stage to redirect to

redirectionParameters - the redirection parameters

redirectTo

void redirectTo(String newStage,
                Map<String,Object> redirectionParameters,
                boolean allowRedirectToSameStage)

Sets the redirection stage.

Parameters:

allowRedirectToSameStage - if T allows redirect to same stage to be set

newStage - the stage to redirect to

redirectionParameters - the redirection parameters

redirectTo

void redirectTo(String newStage,
                String redirectionParameters)

Sets the redirection stage.

Parameters:

newStage - the stage to redirect to

redirectionParameters - the redirection parameters

redirectTo

void redirectTo(String newStage,
                String redirectionParameters,
                boolean allowRedirectToSameStage)

Sets the redirection stage.

Parameters:

allowRedirectToSameStage - if T allows redirect to same stage to be set

newStage - the stage to redirect to

redirectionParameters - the redirection parameters

reportIssue

void reportIssue(String uID,
                 IssueType type,
                 String issueDescription)

Report an issue to the IUsageIssuesManager

Parameters:

uID - the unique identifier for this contribution. for recurring errors not to be added repeatedly

type - the issue type

issueDescription -

reportIssue

void reportIssue(String uID,
                 IssueType type,
                 String issueDescription,
                 Exception exception)

Report an issue to the IUsageIssuesManager

Parameters:

uID - the unique identifier for this contribution. for recurring errors not to be added repeatedly

type - the issue type

issueDescription -

exception - the raised exception

reportIssue

void reportIssue(String uID,
                 IssueType type,
                 String issueDescription,
                 Exception exception,
                 boolean showStackTrace)

Report an issue to the IUsageIssuesManager

Parameters:

uID - the unique identifier for this contribution. for recurring errors not to be added repeatedly

type - the issue type

issueDescription -

exception - the raised exception

showStackTrace - if the stack trace should be generated and attached to the issue description

reportIssue

void reportIssue(UsageIssue issue)

Report an issue to the IUsageIssuesManager

Parameters:

issue - the issue descriptor

setRequest

void setRequest(IDIFRequest difRequest)

Modifier for the DIFRequest Object

Parameters:

difRequest - the Original DifRequest

setSession

void setSession(IDIFSession session)

Modifier for the session object.

Parameters:

session - the session to set

setStage

void setStage(String stage)

Modifier for the current stage

Parameters:

stage - the stage to set

setStageResults

void setStageResults(Map<String,Object> results)

Modifier for the stage results.

Parameters:

results - the results to set

setTemporaryAttributes

void setTemporaryAttributes(Map<String,Object> temporaryAttributes)

Modifier for the 'temporaryAttributes' attribute.

Parameters:

temporaryAttributes - the new temporaryAttributes value to set

setView

void setView(ViewObject view)

Modifier for the view.

Parameters:

view - the ViewObject to set