com.webmethods.caf.faces.data.csp

Class CSPContent

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.CSPContent

All Implemented Interfaces:

IPageFlowScopeAdapter, IContentProvider, ITransactionalContentProvider, IUpdateableContentProvider, Serializable, EventListener, HttpSessionBindingListener

public class CSPContent
extends CSPBaseProvider
implements IUpdateableContentProvider, ITransactionalContentProvider

CSPContent is a logical entity that combines one or more content objects(i.e files stored in the CSP store) identified by same content id. This way, it is possible to combine multiple files in one logical content entity.For example if you sign a contract- all the documents,photos and related stuff can be combined by a single CSPContent.

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

Constructors

Constructor and Description
CSPContent()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyChanges() Store updated CSP indexes to the CSP server.
void	cancelChanges() Reverts all changes made since the last ITransactionalContentProvider.applyChanges() call.
CSPAttachmentsProvider	getAttachmentsProvider()
String	getContentDefinitionId() Each CspContent has a Content Definition which keeps information of where the content itself is stored as well as information about meta-data(indexes).
String	getContentId() Each Content is identified by a unique GUID.
CSPIndex[]	getCspIndexes()
org.apache.commons.fileupload.FileItem	getFileItem()
CSPIndex	getIndexDefinition(String indexId)
CSPIndexDefinitionProvider	getIndexDefinitionProvider()
String	getNodeId()
Object[]	getPropertyKeys() Returns list of properties supported by this content provider.
IUpdateableTableContentProvider	getPropertyKeysProvider()
Class<String>	getType(Object propertyKey) return the type of the property.
Object	getValue(Object propertyKey) Return index value.If index is multi-value it returns an array of values.
boolean	hasProperty(Object propertyKey) Checks if the given property is supported by this content provider
boolean	isNewContent()
boolean	isReadOnly(Object propertyKey) Returns true if the given property is readonly.
void	setContentDefinitionId(String contentDefinitionId)
void	setContentId(String contentId)
void	setFileItem(org.apache.commons.fileupload.FileItem fileItem)
void	setIndexDefinitionProvider(CSPIndexDefinitionProvider indexDefinitionProvider)
void	setNewContent(boolean isNewContent)
void	setNodeId(String nodeId)
void	setValue(Object propertyKey, Object value) Sets new value of the given property

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

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

toString

Constructor Detail

CSPContent

public CSPContent()

Method Detail

isNewContent

public boolean isNewContent()

setNewContent

public void setNewContent(boolean isNewContent)

getFileItem

public org.apache.commons.fileupload.FileItem getFileItem()

setFileItem

public void setFileItem(org.apache.commons.fileupload.FileItem fileItem)

getContentDefinitionId

public String getContentDefinitionId()
                              throws Exception

Each CspContent has a Content Definition which keeps information of where the content itself is stored as well as information about meta-data(indexes).

Returns:

Content Definition id

Throws:

Exception

getPropertyKeysProvider

public IUpdateableTableContentProvider getPropertyKeysProvider()

setContentDefinitionId

public void setContentDefinitionId(String contentDefinitionId)

getContentId

public String getContentId()

Each Content is identified by a unique GUID.

Returns:

Content id

setContentId

public void setContentId(String contentId)

isReadOnly

public boolean isReadOnly(Object propertyKey)
                   throws EvaluationException,
                          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:

EvaluationException

PropertyNotFoundException

setValue

public void setValue(Object propertyKey,
            Object value)
              throws EvaluationException,
                     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:

EvaluationException - if error happens during property assigment

PropertyNotFoundException - if property is not found

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:

a Collection of index ids contained by the CSPContent

getIndexDefinition

public CSPIndex getIndexDefinition(String indexId)
                            throws Exception

Throws:

Exception

getType

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

return the type of the 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 EvaluationException

Return index value.If index is multi-value it returns an array of values.

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:

EvaluationException - if error during property evaluation

PropertyNotFoundException - if property is not supported

getCspIndexes

public CSPIndex[] getCspIndexes()

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

Store updated CSP indexes to the CSP server.

Specified by:

applyChanges in interface ITransactionalContentProvider

Throws:

ContentProviderException - if error happens during commit

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

setIndexDefinitionProvider

public void setIndexDefinitionProvider(CSPIndexDefinitionProvider indexDefinitionProvider)

getIndexDefinitionProvider

public CSPIndexDefinitionProvider getIndexDefinitionProvider()

getAttachmentsProvider

public CSPAttachmentsProvider getAttachmentsProvider()
                                              throws Exception

Throws:

Exception

getNodeId

public String getNodeId()
                 throws Exception

Throws:

Exception

setNodeId

public void setNodeId(String nodeId)