Skip navigation links

oracle.stellent.wcm.core.definition.element
Class ReferencesDefinition

java.lang.Object
oracle.stellent.wcm.core.definition.element.ReferencesDefinition

All Implemented Interfaces:

IReferencesDefinition

Direct Known Subclasses:

ElementDefinition, RegionDefinition

public abstract class ReferencesDefinition

extends java.lang.Object

implements IReferencesDefinition

Represents an individual schema definition that supports element references (static lists and region schemas).

Constructor Summary

ReferencesDefinition()

Method Summary

void	addElementReference(ElementReference elementReference) Add an element reference
void	addProperty(Property property) Add a new property
java.lang.String	getDescription() get the Description
ElementReference	getElementReference(java.lang.String name) Get Element Reference for a given field name
java.util.Collection<java.lang.String>	getElementReferenceNames() Get the element reference names
protected oracle.stellent.wcm.core.definition.element.model.ElementReferenceType	getElementReferenceType(java.lang.String name)
java.util.Collection<ElementReference>	getElementReferenceValues() Get all the element reference values
protected abstract oracle.stellent.wcm.core.definition.element.model.SubElements	getElements() Get the subelements from the definition
java.lang.String	getFieldDescription(java.lang.String fieldName) Get the Description for a field.
java.lang.String	getFieldLabel(java.lang.String fieldName) Get the Label for a field.
java.lang.String	getFieldLocation(java.lang.String fieldName) Get the Location value for a field.
protected abstract java.util.List<JAXBBase>	getItemProperties() Get the Item properties
Property	getProperty(java.lang.String name) Get property by property name
java.lang.String	getPropertyValue(java.lang.String name) Get the property value for the name
void	removeElementReference(java.lang.String name) Remove an element reference by name
void	setDescription(java.lang.String description)
protected abstract void	setElements(oracle.stellent.wcm.core.definition.element.model.SubElements subelements) Set the subelements into the definition
void	setPropertyValue(java.lang.String name, java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReferencesDefinition

public ReferencesDefinition()

Method Detail

setElements

protected abstract void setElements(oracle.stellent.wcm.core.definition.element.model.SubElements subelements)

Set the subelements into the definition

Parameters:

subelements -

getElements

protected abstract oracle.stellent.wcm.core.definition.element.model.SubElements getElements()

Get the subelements from the definition

Returns:

the elements

getItemProperties

protected abstract java.util.List<JAXBBase> getItemProperties()

Get the Item properties

Returns:

list of item properties

getElementReference

public ElementReference getElementReference(java.lang.String name)

Description copied from interface: IReferencesDefinition

Get Element Reference for a given field name

Specified by:

getElementReference in interface IReferencesDefinition

Parameters:

name - the field name

Returns:

the element reference

addElementReference

public void addElementReference(ElementReference elementReference)

Description copied from interface: IReferencesDefinition

Add an element reference

Specified by:

addElementReference in interface IReferencesDefinition

Parameters:

elementReference - the new element

removeElementReference

public void removeElementReference(java.lang.String name)

Description copied from interface: IReferencesDefinition

Remove an element reference by name

Specified by:

removeElementReference in interface IReferencesDefinition

Parameters:

name - the element name

getElementReferenceNames

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

Description copied from interface: IReferencesDefinition

Get the element reference names

Specified by:

getElementReferenceNames in interface IReferencesDefinition

Returns:

collection element reference names

getElementReferenceValues

public java.util.Collection<ElementReference> getElementReferenceValues()

Description copied from interface: IReferencesDefinition

Get all the element reference values

Specified by:

getElementReferenceValues in interface IReferencesDefinition

Returns:

collection of element reference values

getFieldLocation

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

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

Specified by:

getFieldLocation in interface IReferencesDefinition

Parameters:

fieldName - Name of a field

Returns:

Location value or null if fieldname not found

getFieldLabel

public java.lang.String getFieldLabel(java.lang.String fieldName)

Get the Label for a field.

Parameters:

fieldName - Name of a field

Returns:

Label, or null if fieldname not found

getFieldDescription

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

Get the Description for a field.

Specified by:

getFieldDescription in interface IReferencesDefinition

Parameters:

fieldName - Name of a field

Returns:

Description, or null if fieldname not found

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

Description copied from interface: IReferencesDefinition

Get the property value for the name

Specified by:

getPropertyValue in interface IReferencesDefinition

Parameters:

name - the property name

Returns:

the property value

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)

getProperty

public Property getProperty(java.lang.String name)

Description copied from interface: IReferencesDefinition

Get property by property name

Specified by:

getProperty in interface IReferencesDefinition

Parameters:

name - the property name

Returns:

the property

addProperty

public void addProperty(Property property)

Description copied from interface: IReferencesDefinition

Add a new property

Specified by:

addProperty in interface IReferencesDefinition

Parameters:

property - the complex property

getDescription

public java.lang.String getDescription()

get the Description

Specified by:

getDescription in interface IReferencesDefinition

Returns:

Description, or empty string

setDescription

public void setDescription(java.lang.String description)

getElementReferenceType

protected oracle.stellent.wcm.core.definition.element.model.ElementReferenceType getElementReferenceType(java.lang.String name)

Skip navigation links