com.plumtree.remote.prc.content.property
Interface IBaseProperty

All Known Subinterfaces:

IBooleanProperty, IDateProperty, IDoubleProperty, IFileProperty, IImageProperty, IIntegerProperty, IItemCollectionProperty, IItemReferenceProperty, ISelectionListProperty, ITextBlockProperty, ITextLineProperty

public interface IBaseProperty

Base class for all Publisher properties. Sub-types of this class can be added to an IDataEntryTemplate. All property names must be unique in a Data Entry Template, regardless of type. If the property name is not unique, a NameAlreadyInUseException will be thrown when the Data Entry Template is persisted.

See IContentItem for details about retrieving and updating property values.

Method Summary

java.lang.String	getDescription() Returns the description for this property.
java.lang.String	getDisplayName() Returns the property's display name.
java.lang.String	getName() Returns the property name.
void	setDescription(java.lang.String description) Sets the description for this property.
void	setDisplayName(java.lang.String name) Sets the display name for this property.
void	setName(java.lang.String name) Sets the name for this property.

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description for this property.

Returns:

the description of the property

getDisplayName

public java.lang.String getDisplayName()

Returns the property's display name. The display name is what will be displayed in Publisher Explorer for this property. The display name will be the same as the property name if it is not explicitly set.

Returns:

the property display name

getName

public java.lang.String getName()

Returns the property name.

Returns:

the property name

setDescription

public void setDescription(java.lang.String description)

Sets the description for this property. The new value set will not be persisted until this property is added to a Data Entry Template, and IDataEntryTemplate.store is called on that Data Entry Template.

Parameters:

description - the description of the property; cannot be null or longer than 255 characters

Throws:

java.lang.IllegalArgumentException - if the description is longer than 255 characters

setDisplayName

public void setDisplayName(java.lang.String name)

Sets the display name for this property. The display name is what will be displayed in Publisher Explorer for this property. The display name will be the same as the property name if it is not explicitly set. The new value set will not be persisted until this property is added to a Data Entry Template and IDataEntryTemplate.store is called on that Data Entry Template.

Parameters:

name - the display name of the property; cannot be null or longer than 255 characters

Throws:

java.lang.IllegalArgumentException - if the display name is longer than 255 characters

setName

public void setName(java.lang.String name)

Sets the name for this property. The new value set will not be persisted until this property is added to a Data Entry Template, and IDataEntryTemplate.store is called on that Data Entry Template.

All property names must be unique in a Data Entry Template, including properties of different types, otherwise a NameAlreadyInUseException will be thrown when the Data Entry Template is persisted with properties of the same name.

Parameters:

name - the name of the property; cannot be null, empty, or longer than 255 characters. The string used for the name will be trimmed of leading and trailing whitespace when it is stored and is case-insensitive during name comparison.

Throws:

java.lang.IllegalArgumentException - if the name is an empty string or longer than 255 characters