com.webmethods.caf.faces.data.csp

Class CSPEFormTemplateProvider

java.lang.Object

com.webmethods.caf.faces.bean.BaseFacesBean

com.webmethods.caf.faces.bean.BaseFacesSessionBean

com.webmethods.caf.faces.data.csp.CSPBaseProvider

com.webmethods.caf.faces.data.csp.CSPRefreshableContentBaseProvider

com.webmethods.caf.faces.data.csp.CSPEFormTemplateProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, IEFormTemplateProvider, IRefreshable, Serializable, EventListener, HttpSessionBindingListener

public class CSPEFormTemplateProvider
extends CSPRefreshableContentBaseProvider
implements IEFormTemplateProvider

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_INDEX_ID
static int	NAME_INDEX_ID
static int	NODE_ID_INDEX_ID
static int	TEMPLATE_NODE_ID
static int	TYPE_INDEX_ID

Fields inherited from class com.webmethods.caf.faces.data.csp.CSPBaseProvider

fRetrievalModule, fSession

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

fExpireWithPageFlow

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

DATA_BINDING_CLIENTS, EMPTY_RESOURCES, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders

Constructor Summary

Constructors

Constructor and Description
CSPEFormTemplateProvider()

Method Summary

Modifier and Type	Method and Description
String	getContentId()
CSPIndexDefinitionProvider	getIndexDefinitionProvider()
boolean	getNeedRefresh() Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.
byte[]	getTemplateData()
String	getTemplateFileName()
void	refresh() (Re)loads data from the data source.
void	setContentId(String contentId)
void	setIndexDefinitionProvider(CSPIndexDefinitionProvider provider)

Methods inherited from class com.webmethods.caf.faces.data.csp.CSPRefreshableContentBaseProvider

isAutoRefresh, setAutoRefresh, setNeedRefresh, supportsAutoRefresh

Methods inherited from class com.webmethods.caf.faces.data.csp.CSPBaseProvider

checkState, getSession, release, setSession

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

getExpireWithPageFlow, setExpireWithPageFlow, valueBound, valueUnbound

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

createMethodBinding, createMethodExpression, createValueBinding, createValueExpression, createValueExpression, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue

Methods inherited from class java.lang.Object

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

Field Detail

NODE_ID_INDEX_ID

public static final int NODE_ID_INDEX_ID

See Also:

Constant Field Values

TYPE_INDEX_ID

public static final int TYPE_INDEX_ID

See Also:

Constant Field Values

NAME_INDEX_ID

public static final int NAME_INDEX_ID

See Also:

Constant Field Values

TEMPLATE_NODE_ID

public static final int TEMPLATE_NODE_ID

See Also:

Constant Field Values

ACTIVE_INDEX_ID

public static final int ACTIVE_INDEX_ID

See Also:

Constant Field Values

Constructor Detail

CSPEFormTemplateProvider

public CSPEFormTemplateProvider()

Method Detail

getTemplateData

public byte[] getTemplateData()

Specified by:

getTemplateData in interface IEFormTemplateProvider

getTemplateFileName

public String getTemplateFileName()

Specified by:

getTemplateFileName in interface IEFormTemplateProvider

setIndexDefinitionProvider

public void setIndexDefinitionProvider(CSPIndexDefinitionProvider provider)

getIndexDefinitionProvider

public CSPIndexDefinitionProvider getIndexDefinitionProvider()

refresh

public void refresh()
             throws ContentProviderException

Description copied from interface: IRefreshable

(Re)loads data from the data source. Implementation specific meaning can be executing a SQL query or a web service call. All current data will be lost and updated with the new results if successful.

Specified by:

refresh in interface IRefreshable

Throws:

ContentProviderException - if error loading data from the data source

setContentId

public void setContentId(String contentId)

getContentId

public String getContentId()

getNeedRefresh

public boolean getNeedRefresh()

Description copied from interface: IRefreshable

Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.

Implementations may return an accurate value from this method if they can track the changes to the input parameter properties or they may require the clients to call IRefreshable.setNeedRefresh(boolean) explicitely.

Specified by:

getNeedRefresh in interface IRefreshable

Overrides:

getNeedRefresh in class CSPRefreshableContentBaseProvider

Returns:

true when the output properties are not up-to-date with the current input parameters, i.e. IRefreshable.refresh() needs to be executed manually or automatically.