Skip navigation links

oracle.stellent.wcm.core.definition.element
Interface IReferencesDefinition

All Known Implementing Classes:

ElementDefinition, ReferencesDefinition, RegionDefinition

public interface IReferencesDefinition

Interface for the References Definition which is shared by the Region and Element definitions

Method Summary

void	addElementReference(ElementReference newElement) Add an element reference
void	addProperty(Property newProperty) Add a new property
java.lang.String	getDescription() Get the property value for description
ElementReference	getElementReference(java.lang.String fieldName) Get Element Reference for a given field name
java.util.Collection<java.lang.String>	getElementReferenceNames() Get the element reference names
java.util.Collection<ElementReference>	getElementReferenceValues() Get all the element reference values
java.lang.String	getFieldDescription(java.lang.String fieldName) Get the Description for a field.
java.lang.String	getFieldLocation(java.lang.String fieldName) Get the Location value for a field.
Property	getProperty(java.lang.String propertyName) Get property by property name
java.lang.String	getPropertyValue(java.lang.String propertyName) Get the property value for the name
void	removeElementReference(java.lang.String name) Remove an element reference by name

Method Detail

getPropertyValue

java.lang.String getPropertyValue(java.lang.String propertyName)

Get the property value for the name

Parameters:

propertyName - the property name

Returns:

the property value

getElementReferenceNames

java.util.Collection<java.lang.String> getElementReferenceNames()

Get the element reference names

Returns:

collection element reference names

getElementReference

ElementReference getElementReference(java.lang.String fieldName)

Get Element Reference for a given field name

Parameters:

fieldName - the field name

Returns:

the element reference

getDescription

java.lang.String getDescription()

Get the property value for description

Returns:

the description

getFieldLocation

java.lang.String getFieldLocation(java.lang.String fieldName)

Get the Location value for a field. Typically this is a dDocName for an Element Definition

Parameters:

fieldName - Name of a field

Returns:

Location value or null if fieldname not found

getFieldDescription

java.lang.String getFieldDescription(java.lang.String fieldName)

Get the Description for a field.

Parameters:

fieldName - Name of a field

Returns:

Description, or null if fieldname not found

getElementReferenceValues

java.util.Collection<ElementReference> getElementReferenceValues()

Get all the element reference values

Returns:

collection of element reference values

addElementReference

void addElementReference(ElementReference newElement)

Add an element reference

Parameters:

newElement - the new element

removeElementReference

void removeElementReference(java.lang.String name)

Remove an element reference by name

Parameters:

name - the element name

getProperty

Property getProperty(java.lang.String propertyName)

Get property by property name

Parameters:

propertyName - the property name

Returns:

the property

addProperty

void addProperty(Property newProperty)

Add a new property

Parameters:

newProperty - the complex property

Skip navigation links