Package lumis.doui

Class DouiContext

java.lang.Object

lumis.doui.DouiContext

@StableMinor(version="17.0",
             sinceVersion="4.0")
public class DouiContext
extends java.lang.Object

Provides general context information and constants for Doui services

Since:

4.0.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DouiContext.ValidationResult	Result of the controls validation process.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_ROWS
static java.lang.String	DOUI_ORDER_BY_DIR
static java.lang.String	DOUI_ORDER_BY_FIELD
static java.lang.String	DOUI_PARAMETER_ERROR
static java.lang.String	DOUI_PARAMETER_FROM_FORM
static java.lang.String	DOUI_PARAMETER_MAX_ROWS
static java.lang.String	DOUI_PARAMETER_MESSAGE
static java.lang.String	DOUI_PARAMETER_START_AT
static java.lang.String	DOUI_PARAMETER_STORED_VALUES

Constructor Summary

Constructors

Constructor	Description
DouiContext(IServiceInterfaceRequest request, IServiceInterfaceResponse response, ITransaction transaction)

Method Summary

Modifier and Type	Method	Description
protected ControlContainer	createControlContainer()
protected DouiHyperlink	createDouiHyperlink()
protected ProcessActionContainer	createProcessActionContainer()
protected SourceContainer	createSourceContainer()
IServiceInterfaceActionRequest	getActionRequest()
IServiceInterfaceActionResponse	getActionResponse()
ControlContainer	getControlContainer()
IDouiDefinitionProcessor	getDouiDefinitionProcessor()	Returns a doui definition processor that evaluates the ELs present, according to this doui context.
DouiHyperlink	getDouiHyperlink()
DouiServiceInterfaceInstanceDefinition	getDouiServiceInterfaceDefinition()
java.lang.String	getPreviousStoredValue(java.lang.String key)	Returns a previously stored value.
ProcessActionContainer	getProcessActionContainer()
IServiceInterfaceRenderRequest	getRenderRequest()
IServiceInterfaceRenderResponse	getRenderResponse()
IServiceInterfaceRequest	getRequest()
IServiceInterfaceResponse	getResponse()
SourceContainer	getSourceContainer()
java.util.Map<java.lang.String,java.lang.String>	getStoredValues()	Returns a unmodifiable view of the stored values in this context.
ITransaction	getTransaction()
DouiContext.ValidationResult	getValidationResult()	Returns the validation result for this DOUI context.
boolean	isPostback()
boolean	isProcessAction()
void	release()
void	setValidationResult(boolean valid)	Sets the validation result for this DOUI context.
void	storeValue(java.lang.String key, java.lang.String value)	Stores a value.

Methods inherited from class java.lang.Object

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

Field Detail

DOUI_PARAMETER_STORED_VALUES

public static final java.lang.String DOUI_PARAMETER_STORED_VALUES

See Also:

Constant Field Values

DOUI_PARAMETER_FROM_FORM

public static final java.lang.String DOUI_PARAMETER_FROM_FORM

See Also:

Constant Field Values

DOUI_PARAMETER_ERROR

public static final java.lang.String DOUI_PARAMETER_ERROR

See Also:

Constant Field Values

DOUI_PARAMETER_MESSAGE

public static final java.lang.String DOUI_PARAMETER_MESSAGE

See Also:

Constant Field Values

DOUI_PARAMETER_START_AT

public static final java.lang.String DOUI_PARAMETER_START_AT

See Also:

Constant Field Values

DOUI_PARAMETER_MAX_ROWS

public static final java.lang.String DOUI_PARAMETER_MAX_ROWS

See Also:

Constant Field Values

DOUI_ORDER_BY_FIELD

public static final java.lang.String DOUI_ORDER_BY_FIELD

See Also:

Constant Field Values

DOUI_ORDER_BY_DIR

public static final java.lang.String DOUI_ORDER_BY_DIR

See Also:

Constant Field Values

DEFAULT_MAX_ROWS

public static final int DEFAULT_MAX_ROWS

See Also:

Constant Field Values

Constructor Detail

DouiContext

public DouiContext(IServiceInterfaceRequest request,
                   IServiceInterfaceResponse response,
                   ITransaction transaction)
            throws PortalException

Throws:

PortalException

Method Detail

getDouiDefinitionProcessor

public IDouiDefinitionProcessor getDouiDefinitionProcessor()
                                                    throws PortalException

Returns a doui definition processor that evaluates the ELs present, according to this doui context.

The ELs inside the controls are not evaluated. They must be evaluated by the controls themselves.

Throws:

PortalException

Since:

4.1.0

getDouiServiceInterfaceDefinition

public DouiServiceInterfaceInstanceDefinition getDouiServiceInterfaceDefinition()

isPostback

public boolean isPostback()

isProcessAction

public boolean isProcessAction()

getValidationResult

public DouiContext.ValidationResult getValidationResult()

Returns the validation result for this DOUI context.

Returns:

the validation result.

Since:

5.6.0

setValidationResult

public void setValidationResult(boolean valid)

Sets the validation result for this DOUI context.

This method is called by DouiServiceInterface.validate(lumis.doui.DouiContext), and normally should not be called directly, unless the validation process is customized.

Parameters:

valid - true if the validation was successful, false otherwise.

Since:

5.6.0

storeValue

public void storeValue(java.lang.String key,
                       java.lang.String value)

Stores a value.

Parameters:

key - the value key.

value - the value to store.

getStoredValues

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

Returns a unmodifiable view of the stored values in this context.

Returns:

the stored values.

getPreviousStoredValue

public java.lang.String getPreviousStoredValue(java.lang.String key)

Returns a previously stored value.

Parameters:

key - the value key.

Returns:

the value or null if it was not found.

getRequest

public IServiceInterfaceRequest getRequest()

Returns:

Returns the request.

getResponse

public IServiceInterfaceResponse getResponse()

Returns:

Returns the response.

getRenderRequest

public IServiceInterfaceRenderRequest getRenderRequest()

Returns:

Returns the request.

getRenderResponse

public IServiceInterfaceRenderResponse getRenderResponse()

Returns:

Returns the response.

getActionRequest

public IServiceInterfaceActionRequest getActionRequest()

Returns:

Returns the request.

getActionResponse

public IServiceInterfaceActionResponse getActionResponse()

Returns:

Returns the response.

getControlContainer

public ControlContainer getControlContainer()

Returns:

Returns the controlContainer.

createControlContainer

protected ControlContainer createControlContainer()

getSourceContainer

public SourceContainer getSourceContainer()

Returns:

Returns the sourceContainer.

createSourceContainer

protected SourceContainer createSourceContainer()

getProcessActionContainer

public ProcessActionContainer getProcessActionContainer()

createProcessActionContainer

protected ProcessActionContainer createProcessActionContainer()

getDouiHyperlink

public DouiHyperlink getDouiHyperlink()

createDouiHyperlink

protected DouiHyperlink createDouiHyperlink()

getTransaction

public ITransaction getTransaction()

release

public void release()