pt.digitalis.dif.controller.interfaces
Interface IDIFResponse

All Known Implementing Classes:

DIFResponse

public interface IDIFResponse

Defines the expected behavior for a DIF response.

Author:

Rodrigo Gonçalves rgoncalves@digitalis.pt
, Luis Pinto lpinto@digitalis.pt

Created on:

2007/12/05

Method Summary

void	addStageResult(String resultName, Object resultValue) Adds an entry to the stage results map.
IDIFRequest	getRequest()
ResultMessage	getResultMessage() Inspector for the 'resultMessage' attribute.
IStageInstance	getStageInstance()
Object	getStageResult(String resultName) Returns the value of the result with a given name, if it exists
Map<String,Object>	getStageResults() Returns the DIFResponse stage results.
ViewObject	getView() ViewObject inspector.
void	setRequest(IDIFRequest request)
void	setResultMessage(ResultMessage resultMessage) Modifier for the 'resultMessage' attribute.
void	setStageInstance(IStageInstance stageInstance)
void	setStageResults(Map<String,Object> map) Builds the DIFResponse stage results based on an external map.
void	setView(ViewObject newView) ViewObject modifier.

Method Detail

addStageResult

void addStageResult(String resultName,
                    Object resultValue)

Adds an entry to the stage results map.

Parameters:

resultName - the result name

resultValue - the result value

getRequest

IDIFRequest getRequest()

Returns:

the request

getResultMessage

ResultMessage getResultMessage()

Inspector for the 'resultMessage' attribute.

Returns:

the resultMessage value

getStageInstance

IStageInstance getStageInstance()

Returns:

the stageInstance

getStageResult

Object getStageResult(String resultName)

Returns the value of the result with a given name, if it exists

Parameters:

resultName - the result name

Returns:

the value of the result with the supplied name, if it exists

getStageResults

Map<String,Object> getStageResults()

Returns the DIFResponse stage results.

Returns:

The map with the stage results

getView

ViewObject getView()

ViewObject inspector.

Returns:

the theView

setRequest

void setRequest(IDIFRequest request)

Parameters:

request - the request to set

setResultMessage

void setResultMessage(ResultMessage resultMessage)

Modifier for the 'resultMessage' attribute.

Parameters:

resultMessage - the new resultMessage value to set

setStageInstance

void setStageInstance(IStageInstance stageInstance)

Parameters:

stageInstance - the stageInstance to set

setStageResults

void setStageResults(Map<String,Object> map)

Builds the DIFResponse stage results based on an external map.

Parameters:

map - The map with the original stage results

setView

void setView(ViewObject newView)

ViewObject modifier.

Parameters:

newView - the theView to set