org.opencms.cmis
Interface I_CmsPropertyProvider

public interface I_CmsPropertyProvider

Interface for dynamic CMIS properties.

Dynamic properties don't actually exist in the VFS, instead they are read and written by calling methods on the subclasses implementing this interface which have been configured in the repository configuration.

Method Summary

java.lang.String	getName() Returns the name of the dynamic property.
java.lang.String	getPropertyValue(CmsObject cms, CmsResource resource) Reads the property value.
boolean	isWritable() Returns true if this dynamic property is writable.
void	setPropertyValue(CmsObject cms, CmsResource resource, java.lang.String valueToSet) Writes the property value.

Method Detail

getName

java.lang.String getName()

Returns the name of the dynamic property.

The id of the property will consist of the name combined with an opencms-dynamic: prefix.

Returns:

the name of the property

getPropertyValue

java.lang.String getPropertyValue(CmsObject cms,
                                  CmsResource resource)
                                  throws CmsException

Reads the property value.

Parameters:

cms - the current CMS context

resource - the resource for which the property should be read

Returns:

the property value

Throws:

CmsException - if something goes wrong

isWritable

boolean isWritable()

Returns true if this dynamic property is writable.

Returns:

true if the property is writable

setPropertyValue

void setPropertyValue(CmsObject cms,
                      CmsResource resource,
                      java.lang.String valueToSet)
                      throws CmsException

Writes the property value.

Parameters:

cms - the current CMS context.

resource - the resource for which to write the property

valueToSet - the value to write

Throws:

CmsException - if something goes wrong