org.pm4j.core.pm.impl.connector
Interface PmToViewTechnologyConnector

All Known Implementing Classes:
PmToNoViewTechnologyConnector

public interface PmToViewTechnologyConnector

Interface for UI platform specific navigation tasks.

Author:
olaf boede

Method Summary
 PmTabSetConnector createTabSetConnector(PmTabSet pmTabSet)
          Provides a view technology specific connector for tab views.
 java.lang.Object findNamedObject(java.lang.String attrName)
          Finds a named object within the technology specific environment.
 org.pm4j.navi.NaviHistory getNaviHistory()
           
 boolean hasRequestParams()
           
 java.lang.Object readRequestAttribute(java.lang.String attrName)
          Reads a (view technology specific) value from the current request context.
 java.lang.String readRequestValue(java.lang.String attrName)
          Provides a PM-system specific value.
 void redirect(org.pm4j.navi.impl.NaviLinkImpl naviLink)
          Navigates the UI to the specified location.
 void redirectWithRequestParams(java.lang.String toPageId)
          Navigates the UI to the specified location.
 void setRequestAttribute(java.lang.String attrName, java.lang.Object value)
           
 

Method Detail

redirect

void redirect(org.pm4j.navi.impl.NaviLinkImpl naviLink)
Navigates the UI to the specified location.

Parameters:
naviLink - The navigation target. The application stays on the current page when this parameter is null.

redirectWithRequestParams

void redirectWithRequestParams(java.lang.String toPageId)
Navigates the UI to the specified location.

The parameter set of the current request will be added to the new request to be generated.

Parameters:
toPageId - UI platform id of the page to navigate to.

hasRequestParams

boolean hasRequestParams()
Returns:
true when the current location was started with pm4j request parametets.

readRequestValue

java.lang.String readRequestValue(java.lang.String attrName)
Provides a PM-system specific value.

In case of web applications it provides a parameter that is encoded within the 'pm4j' request attribute.

Parameters:
attrName - Name of the attribute.
Returns:
The attribute value. Is null when there is no attribute for the given name.

getNaviHistory

org.pm4j.navi.NaviHistory getNaviHistory()
Returns:
The history of visited pages.

readRequestAttribute

java.lang.Object readRequestAttribute(java.lang.String attrName)
Reads a (view technology specific) value from the current request context.

In case of a web application it provides the value of an http request attribute.

Parameters:
attrName - Name (key) of the attribute.
Returns:
The found value. May be null.

setRequestAttribute

void setRequestAttribute(java.lang.String attrName,
                         java.lang.Object value)

findNamedObject

java.lang.Object findNamedObject(java.lang.String attrName)
Finds a named object within the technology specific environment.

Concrete implementations may provide here HTTP attributes as well as EJB and Spring attributes.

Parameters:
attrName - Name of the attribute to find.
Returns:
The found attribute value or null.

createTabSetConnector

PmTabSetConnector createTabSetConnector(PmTabSet pmTabSet)
Provides a view technology specific connector for tab views.

Parameters:
pmTabSet - The tab set model to get a connector for.
Returns:
The view technology specific tab set connector.