|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface
for managing Publisher properties.
Handles creation of various types of
Publisher properties, all of which are sub-types of
IBaseProperty
.
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.
Method Summary | |
IBooleanProperty |
createBooleanProperty(java.lang.String name,
java.lang.String description)
Creates a boolean property. |
IDateProperty |
createDateProperty(java.lang.String name,
java.lang.String description)
Creates a date property. |
IDoubleProperty |
createDoubleProperty(java.lang.String name,
java.lang.String description)
Creates a double property. |
IFileProperty |
createFileProperty(java.lang.String name,
java.lang.String description)
Creates a file property. |
IImageProperty |
createImageProperty(java.lang.String name,
java.lang.String description)
Creates an image property. |
IIntegerProperty |
createIntegerProperty(java.lang.String name,
java.lang.String description)
Creates an integer property. |
IItemCollectionProperty |
createItemCollectionProperty(java.lang.String name,
java.lang.String description)
Creates a content item collection property. |
IItemReferenceProperty |
createItemReferenceProperty(java.lang.String name,
java.lang.String description)
Creates a content item reference property. |
ISelectionListProperty |
createSelectionListProperty(java.lang.String name,
java.lang.String description,
ISelectionList selectionList)
Creates a selection list property with an existing selection list. |
ITextBlockProperty |
createTextBlockProperty(java.lang.String name,
java.lang.String description)
Creates a text block property. |
ITextLineProperty |
createTextLineProperty(java.lang.String name,
java.lang.String description)
Creates a text line property. |
Method Detail |
public IBooleanProperty createBooleanProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
IBooleanProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic IDateProperty createDateProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
IDateProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic IDoubleProperty createDoubleProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
IDoubleProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic IFileProperty createFileProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
IFileProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic IImageProperty createImageProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
IImageProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic IIntegerProperty createIntegerProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
ITextLineProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic IItemCollectionProperty createItemCollectionProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
IItemCollectionProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic IItemReferenceProperty createItemReferenceProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
IItemReferenceProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic ISelectionListProperty createSelectionListProperty(java.lang.String name, java.lang.String description, ISelectionList selectionList)
IllegalStateException
will be thrown when IDataEntryTemplate.store
is called.
The following example demonstrates creating a selection list and a selection list property.
// Create a selection list representing states String[] stateOptionValues = {"CA", "MA"}; ISelectionList stateSelectionList = selectionListManager.createSelectionList(rootFolder, "State Selection List", stateOptionValues); stateSelectionList.store(); // Create a selection list property that uses the selection list ISelectionListProperty stateSelectionListProperty = propertyManager.createSelectionListProperty("State Selection List Property", "Choose a state.", stateSelectionList); // Get the selection list ISelectionList originalSelectionList = stateSelectionListProperty.getSelectionList(); // The returned selection list is the same as the stateSelectionList above. // Set the selection list on the property stateSelectionListProperty.setSelectionList(originalSelectionList); // The selection list is identical, so there // is no functional change to the selection list property.
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.description
- the description of the property;
cannot be null
or longer than 255 charactersselectionList
- an existing selection list;
cannot be null
ISelectionListProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic ITextBlockProperty createTextBlockProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
ITextBlockProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characterspublic ITextLineProperty createTextLineProperty(java.lang.String name, java.lang.String description)
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.description
- the description of the property;
cannot be null
or longer than 255 characters
ITextLineProperty
java.lang.IllegalArgumentException
- if the
name or description is a string longer than 255 characters
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.