Package com.webmethods.caf.faces.data.bpm

Class BpmProcessContentProvider

java.lang.Object

com.webmethods.caf.faces.bean.BaseFacesBean

com.webmethods.caf.faces.bean.BaseFacesSessionBean

com.webmethods.caf.faces.data.bpm.BpmProcessContentProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, IContentProvider, IRefreshable, IRefreshableContentProvider, ITransactionalContentProvider, IUpdateableContentProvider, EventListener, HttpSessionBindingListener

public class BpmProcessContentProvider
extends BaseFacesSessionBean
implements IRefreshableContentProvider, ITransactionalContentProvider, IPageFlowScopeAdapter

Content provider which implements access to ad-hoc business process instance

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoRefresh
protected boolean	needRefresh
protected IBpmProcess	process
protected String	processID
protected IBpmProcessManager	processManager
static final String	PROPERTY_PROCESS
static final String	PROPERTY_PROCESS_ID

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	Description
BpmProcessContentProvider()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	applyChanges()	Persists any changes done to this business process instance
void	cancelChanges()	Reverts all changes made since the last ITransactionalContentProvider.applyChanges() call.
void	delete()	Deletes this business process instance and all associated collaboration tasks.
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.
IBpmProcess	getProcess()	Returns business process instance data
String	getProcessID()	Returns business process instance ID
Object[]	getPropertyKeys()	Returns list of properties supported by this content provider.
Class<?>	getType(Object propertyKey)	Returns java type of the given property
Object	getValue(Object propertyKey)	Returns value of the given property
boolean	hasProperty(Object propertyKey)	Checks if the given property is supported by this content provider
boolean	isAutoRefresh()	Returns true if the provider is currenlty in auto-refresh mode
boolean	isReadOnly(Object propertyKey)	Returns true if the given property is readonly.
void	refresh()	(Re)loads data from the data source.
protected void	release()	Override this method to release any resources associated with this session.
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	setProcessID(String processID)	Sets business process instance ID
void	setValue(Object propertyKey, Object value)	Sets new value of the given property
boolean	supportsAutoRefresh()	Returns true if this content provider supports auto refresh feature.

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

Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider

toString

Methods inherited from interface com.webmethods.caf.faces.bean.IPageFlowScopeAdapter

getExpireWithPageFlow, setExpireWithPageFlow

Field Details

PROPERTY_PROCESS_ID

public static final String PROPERTY_PROCESS_ID

See Also:

• Constant Field Values

PROPERTY_PROCESS

public static final String PROPERTY_PROCESS

See Also:

• Constant Field Values

processID

protected String processID

needRefresh

protected boolean needRefresh

autoRefresh

protected boolean autoRefresh

processManager

protected IBpmProcessManager processManager

process

protected IBpmProcess process

Constructor Details

BpmProcessContentProvider

public BpmProcessContentProvider()

Default constructor

Method Details

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

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

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)

getPropertyKeys

public Object[] getPropertyKeys()

Description copied from interface: IContentProvider

Returns list of properties supported by this content provider. Can return Object[0], never null.

Specified by:

getPropertyKeys in interface IContentProvider

Returns:

array of property keys which is typically of type String or Integer

getType

public Class<?> getType(Object propertyKey)
                 throws PropertyNotFoundException

Description copied from interface: IContentProvider

Returns java type of the given property

Specified by:

getType in interface IContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

property java Class

Throws:

PropertyNotFoundException - if property is not supported

getValue

public Object getValue(Object propertyKey)
                throws ELException,
PropertyNotFoundException

Description copied from interface: IContentProvider

Returns value of the given property

Specified by:

getValue in interface IContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

value of the property, can be null

Throws:

PropertyNotFoundException - if property is not supported

ELException

hasProperty

public boolean hasProperty(Object propertyKey)

Description copied from interface: IContentProvider

Checks if the given property is supported by this content provider

Specified by:

hasProperty in interface IContentProvider

Parameters:

propertyKey - property key of type String or Integer

Returns:

true if property is supported

applyChanges

public void applyChanges()
                  throws ContentProviderException

Persists any changes done to this business process instance

Specified by:

applyChanges in interface ITransactionalContentProvider

Throws:

ContentProviderException - if error happens during commit

delete

public void delete()
            throws ContentProviderException

Deletes this business process instance and all associated collaboration tasks. It does not delete the owner (root) task for the business process

Throws:

ContentProviderException

cancelChanges

public void cancelChanges()
                   throws ContentProviderException

Description copied from interface: ITransactionalContentProvider

Reverts all changes made since the last ITransactionalContentProvider.applyChanges() call.

Specified by:

cancelChanges in interface ITransactionalContentProvider

Throws:

ContentProviderException

isReadOnly

public boolean isReadOnly(Object propertyKey)
                   throws ELException,
PropertyNotFoundException

Description copied from interface: IUpdateableContentProvider

Returns true if the given property is readonly. If it is readonly, IUpdateableContentProvider.setValue(Object, Object) will definitely fail.

Specified by:

isReadOnly in interface IUpdateableContentProvider

Parameters:

propertyKey - property key of type String or Integer

Returns:

true if the property is readonly

Throws:

PropertyNotFoundException

ELException

setValue

public void setValue(Object propertyKey,
 Object value)
              throws ELException,
PropertyNotFoundException

Description copied from interface: IUpdateableContentProvider

Sets new value of the given property

Specified by:

setValue in interface IUpdateableContentProvider

Parameters:

propertyKey - property key of type String or Integer

value - new property value

Throws:

PropertyNotFoundException - if property is not found

ELException

getProcessID

public String getProcessID()

Returns business process instance ID

Returns:

setProcessID

public void setProcessID(String processID)

Sets business process instance ID

Parameters:

processID -

getProcess

public IBpmProcess getProcess()
                       throws ContentProviderException

Returns business process instance data

Returns:

Throws:

ContentProviderException

release

protected void release()

Description copied from class: BaseFacesSessionBean

Override this method to release any resources associated with this session. Please note, the FacesContext is not valid for this function

Specified by:

release in class BaseFacesSessionBean