com.sapportals.wcm.repository.service.layout.info

Class RenderObjectData

java.lang.Object
  com.sapportals.wcm.repository.service.layout.info.RenderObjectData

public final class RenderObjectData
extends Object

offers a structured set of information fields as well as the possibility to add freely defined information fields to a list. All objects that are returned by this class offer return values that implement the IField interface which combines information about the actual value as well as label and tooltip information that can be used for rendering this value. The StandardDataField constants define all information elements which can be simply set by classes within the rendering process.

Nested Class Summary

static class

RenderObjectData.InvalidConfiguration a small, immutable container holding information about an invalid configuration.

Field Summary

static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	ALIAS
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	DEF_PARAM
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	FLAVOR
static FieldIdentifier[]	IDENTIFIERS
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	INSTANTIATER
static int	INVALID_508
static int	INVALID_ALIAS
static int	INVALID_BUNDLE
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	JAVA_CLASS
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	LIST_TYPE
static int	NO_MAPPING
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	RID
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	STARTRID
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField	SUPPORT508

Constructor Summary

RenderObjectData(IResourceContext context)

Method Summary

void	addAdditionalParameters(String source, IParameters parameters) adds the parameterization for the render object that has been provided by the specified source.
void	addUnstructuredInfo(Field field) adds a field to the list of unstructed information.
void	addUnstructuredInfo(String label, String value) creates a standard Field instance with an arbritary Identifier.
List	getAdditionalParameterFields(String source)
List	getAdditionalParameterSources()
List	getFields() returns a new list instance that contains all fields that - belong to the list of StandardDataFields and - are not null The list is ordered the same way the IDENTIFIERS-array is ordered.
RenderObjectData.InvalidConfiguration	getInvConfig()
List	getParameterFields()
Status	getStatus()
List	getUnstructuredInfo()
void	set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id, Object value) sets the new value for the StandardDataField of this object.
void	set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id, String value) sets the new value for the StandardDataField of this object.
void	setInvConfig(RenderObjectData.InvalidConfiguration configuration)
void	setParameters(IParameters parameters)
void	setStatus(Status status)

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_ALIAS

public static final int INVALID_ALIAS

See Also:

Constant Field Values

INVALID_508

public static final int INVALID_508

See Also:

Constant Field Values

NO_MAPPING

public static final int NO_MAPPING

See Also:

Constant Field Values

INVALID_BUNDLE

public static final int INVALID_BUNDLE

See Also:

Constant Field Values

DEF_PARAM

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField DEF_PARAM

ALIAS

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField ALIAS

JAVA_CLASS

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField JAVA_CLASS

RID

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField RID

STARTRID

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField STARTRID

INSTANTIATER

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField INSTANTIATER

LIST_TYPE

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField LIST_TYPE

FLAVOR

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField FLAVOR

SUPPORT508

public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField SUPPORT508

IDENTIFIERS

public static final FieldIdentifier[] IDENTIFIERS

Constructor Detail

RenderObjectData

public RenderObjectData(IResourceContext context)

Method Detail

set

public void set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id,
                String value)

sets the new value for the StandardDataField of this object.

Parameters:

id, - the field for which the new value is to be added, must not be null

value, - the new value for this field. If the value is null, or "".equals(value) == true, the value will be set to "-"

set

public void set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id,
                Object value)

sets the new value for the StandardDataField of this object.

Parameters:

id, - the field for which the new value is to be added, must not be null

value, - the new value for this field. If the value is null, or "".equals(value) == true, the value will be set to "-"

addUnstructuredInfo

public void addUnstructuredInfo(Field field)

adds a field to the list of unstructed information. This list allows rendering objects to add information that is specific to them (e.g. for an ILayoutController the list of registered Control instances). These objects do not fit in one of the other buckets of information and are therefore added to this list.

Parameters:

field - an entry for the renderer-specific information for this RenderObjectData, must not be null

addUnstructuredInfo

public void addUnstructuredInfo(String label,
                                String value)

creates a standard Field instance with an arbritary Identifier. The label and tooltip of this field will be the value of the label-parameter and not translated. The value-parameter is used as value of that Field. The field will be readonly, have no condition and use the Locale of this class

Parameters:

label - the label to use, must not be null

value - the value to display, must not be null

getUnstructuredInfo

public List getUnstructuredInfo()

Returns:

a List implementation that only contains objects that implement the IField interface. The list will not contain null elements. The ordering of the list might be changed between calls.

setParameters

public void setParameters(IParameters parameters)

Parameters:

parameters - the parameters (which are usually defined by the ICustomizingController and used for the configuration of this rendering object This method should normally be called by the rendering object itself to ensure that
- only the parameters that are understood by the rendering object are listed
- the final set of parameters (there might be different sources!) that is used for rendering is actually transmitted here

getFields

public List getFields()

returns a new list instance that contains all fields that
- belong to the list of StandardDataFields and - are not null The list is ordered the same way the IDENTIFIERS-array is ordered.

Returns:

a new list instance that might be empty, but never null

getParameterFields

public List getParameterFields()

Returns:

a new list instance that only contains objects that implement the IField interface and does not contain null references. If no IParameters have been defined via the setParameters method, it will return an empty list, but never null. The IField instances each represent a single parameter value.

addAdditionalParameters

public void addAdditionalParameters(String source,
                                    IParameters parameters)

adds the parameterization for the render object that has been provided by the specified source. If already a parameterization for the same source has been provided, this data will be lost.

Parameters:

source - the name of the parameter source, that also will be used to render the information about this source. Must not be null.

parameters - the parameters specified by the given source. Must not be null.

getAdditionalParameterSources

public List getAdditionalParameterSources()

Returns:

a new list instance of all parameter sources defined for this render object. If no additional sources have been defined, this method will return an empty list, but never null.

getAdditionalParameterFields

public List getAdditionalParameterFields(String source)

Parameters:

source - the source the paramters are needed for.

Returns:

a new list instance that only holds IField instances and no null references. It might be empty, but never null.

getInvConfig

public RenderObjectData.InvalidConfiguration getInvConfig()

Returns:

the invalid configuration data for this render object, might be null

setInvConfig

public void setInvConfig(RenderObjectData.InvalidConfiguration configuration)

Parameters:

configuration - the invalid configuration data for the render object, might be null

getStatus

public Status getStatus()

Returns:

setStatus

public void setStatus(Status status)

Parameters:

status -

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM