com.webmethods.caf.faces.data.csp
Class CSPPreviewImageProvider

java.lang.Object
  extended by com.webmethods.caf.faces.bean.BaseFacesBean
      extended by com.webmethods.caf.faces.bean.BaseFacesSessionBean
          extended by com.webmethods.caf.faces.data.csp.CSPBaseProvider
              extended by com.webmethods.caf.faces.data.csp.CSPRefreshableContentBaseProvider
                  extended by com.webmethods.caf.faces.data.csp.CSPPreviewImageProvider
All Implemented Interfaces:
IPageFlowScopeAdapter, IRefreshable, Serializable

public class CSPPreviewImageProvider
extends CSPRefreshableContentBaseProvider

Provider for preview of a content object.

See Also:
Serialized Form

Field Summary
 
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, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders
 
Constructor Summary
CSPPreviewImageProvider()
           
 
Method Summary
protected  void checkState()
          Check if a RetrievalModule has been properly inited.If not it most probably means a session is not set.
 CSPContentObject getContentObject()
           
 String getHeight()
           
 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.
 String getPreviewImageUrl()
           
 String getWidth()
           
 void refresh()
          (Re)loads data from the data source.
 void setContentObject(CSPContentObject contentObject)
           
 void setHeight(String height)
           
 void setWidth(String width)
           
 
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
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, createValueBinding, 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
 

Constructor Detail

CSPPreviewImageProvider

public CSPPreviewImageProvider()
Method Detail

checkState

protected void checkState()
Description copied from class: CSPBaseProvider
Check if a RetrievalModule has been properly inited.If not it most probably means a session is not set.

Overrides:
checkState in class CSPBaseProvider

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.

Throws:
ContentProviderException - if error loading data from the data source

getWidth

public String getWidth()

setWidth

public void setWidth(String width)

getHeight

public String getHeight()

setHeight

public void setHeight(String height)

setContentObject

public void setContentObject(CSPContentObject contentObject)

getContentObject

public CSPContentObject getContentObject()

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.

getPreviewImageUrl

public String getPreviewImageUrl()