atg.repository.servlet
Interface RepositoryFormData

All Known Implementing Classes:

B2BRepositoryFormHandler, MultiProfileAddFormHandler, MultiProfileForm, MultiProfileUpdateFormHandler, MultiUserAddFormHandler, MultiUserUpdateFormHandler, RepositoryAssetFormHandler, RepositoryFormDataImpl, RepositoryFormHandler, ScheduledOrderHandler, WorkflowTaskFormSubject, XMLRepositoryFormHandler

public interface RepositoryFormData

This interface defines the methods that must be implemented by classes which will use the

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

boolean	getCheckForReadOnlyProperties() Returns whether or not the form handler should throw an exception when updating item properties and read only properties are in the value dictionary.
boolean	getCheckForRequiredProperties() Gets whether or not the form handler should check that all the required properties are present during the create/update operations.
boolean	getEditMapsAsLists() Gets the property EditMapsAsLists.
atg.repository.servlet.RepositoryEditorErrorHandler	getErrorHandler() Return an object responsible for handling form errors
boolean	getExtractDefaultValuesFromItem() Returns whether or not property values should be extracted from a repository item if they do not have values specified in the form.
RepositoryItemDescriptor	getItemDescriptor() Return the item descriptor for the top-level item or null
ApplicationLogging	getLogger() The component to use for logging
java.lang.String	getMapKeyValueSeparator() The String used as a key/value separator in map data
MutableRepository	getRepository() Returns the repository this objects operates on.
java.lang.String	getRepositoryId() Returns the repository id of the item being manipulated.
RepositoryItem	getRepositoryItem() The current repository item or null if no current item exists
atg.repository.servlet.RepositoryItemEditor	getRepositoryItemEditor() Return an implementaion of RepositoryItemEditor
java.util.Dictionary	getValue() Returns a dictionary that stores the pending property values associated with an operation on the repository item (e.g.
boolean	isCreateTransientItems() Gets property CreateTransientItems.
boolean	isRequireMapKeys() Indicates if the form should require keys for all entries in Map properties.
boolean	isSortRepositoryItemSets() Indicates if the form should display Sets of RepositoryItems sorted according to their display names.
boolean	isTrimProperty(java.lang.String pProperty) Tests whether pProperty should be trimmed or not
boolean	isUpdateItemsInCollection() Indicates if the form should update individual collection items when updating a collection property.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getRepositoryItemEditor

atg.repository.servlet.RepositoryItemEditor getRepositoryItemEditor()

Return an implementaion of RepositoryItemEditor

Returns:

an editor implementation

getErrorHandler

atg.repository.servlet.RepositoryEditorErrorHandler getErrorHandler()

Return an object responsible for handling form errors

Returns:

the form error handler

getValue

java.util.Dictionary getValue()

Returns a dictionary that stores the pending property values associated with an operation on the repository item (e.g. create, update).

Returns:

the value dictionary

getItemDescriptor

RepositoryItemDescriptor getItemDescriptor()
                                           throws RepositoryException

Return the item descriptor for the top-level item or null

Returns:

the item descriptor or null on error

Throws:

RepositoryException

getRepositoryId

java.lang.String getRepositoryId()

Returns the repository id of the item being manipulated.

Returns:

the repository ID

getRepository

MutableRepository getRepository()

Returns the repository this objects operates on. If you leave this as null, you can use the repositoryPathName as the way of specifying the repository to use. That method is more dynamic and allows you to create a form which sets the repository via a property in the form.

Returns:

the repository

getRepositoryItem

RepositoryItem getRepositoryItem()

The current repository item or null if no current item exists

Returns:

the repository item or null

getMapKeyValueSeparator

java.lang.String getMapKeyValueSeparator()

The String used as a key/value separator in map data

Returns:

the map key/value separator string

getExtractDefaultValuesFromItem

boolean getExtractDefaultValuesFromItem()

Returns whether or not property values should be extracted from a repository item if they do not have values specified in the form.

getEditMapsAsLists

boolean getEditMapsAsLists()

Gets the property EditMapsAsLists. If this is true, the interface for editing maps is as list items using a special "keys" sub-property to define the key. If false, you edit maps "as is". This allows you to modify properties of existing map entries, but not to add new entries.

getCheckForReadOnlyProperties

boolean getCheckForReadOnlyProperties()

Returns whether or not the form handler should throw an exception when updating item properties and read only properties are in the value dictionary. Otherwise, read only properties are just skipped.

getCheckForRequiredProperties

boolean getCheckForRequiredProperties()

Gets whether or not the form handler should check that all the required properties are present during the create/update operations. If true, an error will be raised for any required property that is missing.

Returns:

true to force check for required properties

isCreateTransientItems

boolean isCreateTransientItems()

Gets property CreateTransientItems. If true, newly created items remain transient and are not persisted in the repository with a call to addItem.

Returns:

true to create transient items

isRequireMapKeys

boolean isRequireMapKeys()

Indicates if the form should require keys for all entries in Map properties.

Returns:

true to require map keys

isSortRepositoryItemSets

boolean isSortRepositoryItemSets()

Indicates if the form should display Sets of RepositoryItems sorted according to their display names.

Returns:

true to sort Sets of RepositoryItems

isTrimProperty

boolean isTrimProperty(java.lang.String pProperty)

Tests whether pProperty should be trimmed or not

Parameters:

pProperty - the name of the property to check to be trimmed

Returns:

true if pProperty should be trimmed

isUpdateItemsInCollection

boolean isUpdateItemsInCollection()

Indicates if the form should update individual collection items when updating a collection property.

Returns:

true if the individual collection items shoud be updated.

getLogger

ApplicationLogging getLogger()

The component to use for logging

Returns:

the logger