Oracle® WebCenter Interaction Development Kit 10.3.3.0.0

Plumtree.Remote.PRC.Content.Property Namespace

Contains Publisher properties and the Property Manager class. (See Content Item Examples for sample code on how to create and add properties to a Data Entry Template.)

Refer to the Administrator Guide for AquaLogic Interaction Publisher for additional details on property types and usage.

Note: Property names cannot be an empty string, cannot be longer than 255 characters and are case-insensitive.

Since IDK 5.2

Namespace hierarchy

Interfaces

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

IBooleanProperty Represents a bool property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty. The value of the property can be retrieved using GetBooleanPropertyValue and updated using SetBooleanPropertyValue.
IDateProperty Represents a date property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty. The value of the property can be retrieved using GetDatePropertyValue and updated using SetDatePropertyValue.
IDoubleProperty Represents a double property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty. The value of the property can be retrieved using GetDoublePropertyValue and updated using SetDoublePropertyValue.
IFileProperty Represents a file property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty.

A file property allows a file to be uploaded as the property value in a content item.

The value of the property can be retrieved using GetFilePropertyValue and updated using SetFilePropertyValue.
IImageProperty Represents an image property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty.

An image property allows an image file to be uploaded as the property value in a content item.

The value of the property can be retrieved using GetImagePropertyValue and updated using SetImagePropertyValue.
IIntegerProperty Represents an integer property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty. The value of the property can be retrieved using GetIntegerPropertyValue and updated using SetIntegerPropertyValue.
IItemCollectionProperty Represents a content item collection property, which contains an array of content items and can be added to an IDataEntryTemplate. A sub-type of IBaseProperty.

An item collection property allows multiple existing content items to be set as the property value in a content item that contains this property.

The value of the property can be retrieved using GetItemCollectionPropertyValue and updated using SetItemCollectionPropertyValue.
IItemReferenceProperty Represents a content item reference property, which contains a single content item and can be added to an IDataEntryTemplate. A sub-type of IBaseProperty.

An item reference property allows an existing content item to be set as the property value in a content item that contains this property.

The value of the property can be retrieved using GetItemReferencePropertyValue and updated using SetItemReferencePropertyValue.
IPropertyManager Interface for managing Publisher properties. Handles creation of various types of Publisher properties, all of which are sub-types of IBaseProperty.

After a property is created, it can be added to a new or persisted IDataEntryTemplate using IDataEntryTemplate.AddProperty. See IDataEntryTemplate code sample and documentation on how to create properties of various types and add them to a new Data Entry Template.

No Store method is needed to persist a property after it is created.

Property objects cannot be added to a folder and thus they are not retrievable by themselves. Any properties that are not added to a Data Entry Template will be "lost". IDataEntryTemplate.GetAllProperties will return all properties that have been added to a template if the template was stored after the property addition.

Refer to the Administrator Guide for AquaLogic Interaction Publisher for additional details on Publisher properties and their usage.
ISelectionListProperty Represents a selection list property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty.

A selection list property allows a user to select a pre-defined text value in the associated selection list as the property value in a content item that contains this property.

The value of the property can be retrieved using GetSelectionListPropertyValue and updated using SetSelectionListPropertyValue.
ITextBlockProperty Represents a text block property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty. The value of the property can be retrieved using GetTextBlockPropertyValue and updated using SetTextBlockPropertyValue.
ITextLineProperty Represents a text line property, which can be added to an IDataEntryTemplate. A sub-type of IBaseProperty. The value of the property can be retrieved using GetTextLinePropertyValue and updated using SetTextLinePropertyValue.