com.webmethods.caf.faces.data.eform

Class EFormFileTemplateProvider

java.lang.Object

com.webmethods.caf.faces.data.eform.EFormFileTemplateProvider

All Implemented Interfaces:

IEFormTemplateProvider, IRefreshable

public class EFormFileTemplateProvider
extends Object
implements IEFormTemplateProvider, IRefreshable

Constructor Summary

Constructors

Constructor and Description
EFormFileTemplateProvider()
EFormFileTemplateProvider(String url)
EFormFileTemplateProvider(URL url)

Method Summary

Modifier and Type	Method and Description
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()
String	getUrl()
boolean	isAutoRefresh() Returns true if the provider is currenlty in auto-refresh mode
void	refresh() (Re)loads data from the data source.
void	setAutoRefresh(boolean autorefresh) Sets auto refresh mode on.
void	setNeedRefresh(boolean needRefresh) Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).
void	setUrl(String url)
boolean	supportsAutoRefresh() Returns true if this content provider supports auto refresh feature.

Methods inherited from class java.lang.Object

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

Constructor Detail

EFormFileTemplateProvider

public EFormFileTemplateProvider()

EFormFileTemplateProvider

public EFormFileTemplateProvider(String url)

EFormFileTemplateProvider

public EFormFileTemplateProvider(URL url)

Method Detail

getTemplateData

public byte[] getTemplateData()

Specified by:

getTemplateData in interface IEFormTemplateProvider

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getTemplateFileName

public String getTemplateFileName()

Specified by:

getTemplateFileName in interface IEFormTemplateProvider

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

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

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.

isAutoRefresh

public boolean isAutoRefresh()

Description copied from interface: IRefreshable

Returns true if the provider is currenlty in auto-refresh mode

Specified by:

isAutoRefresh in interface IRefreshable

Returns:

false if auto-refresh mode is off or not supported

setAutoRefresh

public void setAutoRefresh(boolean autorefresh)
                    throws ContentProviderException

Description copied from interface: IRefreshable

Sets auto refresh mode on. When auto refresh mode is on, the provider calls IRefreshable.getNeedRefresh() to determine whether the refresh needs to be done before returning any result properties. If it returns true, the provider calls IRefreshable.refresh() method to updated the result properties.

Specified by:

setAutoRefresh in interface IRefreshable

Parameters:

autorefresh - true to turn it on

Throws:

ContentProviderException - if auto refresh mode is not supported

See Also:

IRefreshable.supportsAutoRefresh(), IRefreshable.getNeedRefresh(), IRefreshable.setNeedRefresh(boolean)

setNeedRefresh

public void setNeedRefresh(boolean needRefresh)

Description copied from interface: IRefreshable

Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).

Specified by:

setNeedRefresh in interface IRefreshable

Parameters:

needRefresh - true if the input parameters have changed

supportsAutoRefresh

public boolean supportsAutoRefresh()

Description copied from interface: IRefreshable

Returns true if this content provider supports auto refresh feature.

Specified by:

supportsAutoRefresh in interface IRefreshable

Returns:

true when auto refresh is supported

See Also:

IRefreshable.setAutoRefresh(boolean)