atg.droplet

Class ArrayOfBeanPathParamDescriptor

java.lang.Object

java.beans.FeatureDescriptor

atg.beans.SerializableFeatureDescriptor

atg.droplet.ParamDescriptor

atg.droplet.DynamicParamDescriptor

atg.droplet.ArrayOfBeanPathParamDescriptor

All Implemented Interfaces:

java.io.Serializable

public class ArrayOfBeanPathParamDescriptor
extends DynamicParamDescriptor

This is a dynamic ParamDescriptor which allows you to define an output parameter whose type is an array of another bean. The other bean is specified as an absolute path to a component in nucleus.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.beans.SerializableFeatureDescriptor

BUNDLE_ATTRIBUTE_NAME, LOCALE_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
ArrayOfBeanPathParamDescriptor()
ArrayOfBeanPathParamDescriptor(java.lang.String pName, java.lang.String pDescription, java.lang.Class pParamClass, boolean pOptional, boolean pLocal, java.lang.String pBeanPath) Construct an ArrayOfBeanPathParamDescriptor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBeanPath()
ObjectTypeInfo	getParamInfo(ParamDescriptorResolver pResolver) Returns the type of the parameter by first getting the type of a bean that is specified in the nucleus hierarchy.
void	setBeanPath(java.lang.String pBeanPath) Sets the property BeanPath.

Methods inherited from class atg.droplet.ParamDescriptor

getParamClass, getRenderParamDescriptors, isLocal, isOptional, isRenderable, setLocal, setOptional, setParamClass, setRenderParamDescriptors, toString

Methods inherited from class atg.beans.SerializableFeatureDescriptor

copyFeatureDescriptor, getCurrentLocale, getDisplayName, getDisplayName, getDisplayNameResource, getDisplaySortString, getLocalizedDisplayName, getLocalizedResourceBundle, getLocalizedResourceBundle, getResourceBundle, getShortDescription, getShortDescriptionResource, getSortString, setDisplayNameResource, setShortDescriptionResource

Methods inherited from class java.beans.FeatureDescriptor

attributeNames, getName, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ArrayOfBeanPathParamDescriptor

public ArrayOfBeanPathParamDescriptor()

ArrayOfBeanPathParamDescriptor

public ArrayOfBeanPathParamDescriptor(java.lang.String pName,
                                      java.lang.String pDescription,
                                      java.lang.Class pParamClass,
                                      boolean pOptional,
                                      boolean pLocal,
                                      java.lang.String pBeanPath)

Construct an ArrayOfBeanPathParamDescriptor. Most of these arguments are the same as those to ParamDescriptor. The last argument, pBeanPath, is the name of the input parameter that we should base our output type on. This should be the parameter name of an BeanPath (a bean that describes the type of a class of related beans). Our output type is an array of these types.

Method Detail

setBeanPath

public void setBeanPath(java.lang.String pBeanPath)

Sets the property BeanPath. This is the name of the input parameter, which should be a BeanPath, that we use to based our output parameter's type on.

getBeanPath

public java.lang.String getBeanPath()

Returns:

The value of the property BeanPath.

getParamInfo

public ObjectTypeInfo getParamInfo(ParamDescriptorResolver pResolver)

Returns the type of the parameter by first getting the type of a bean that is specified in the nucleus hierarchy. If that bean is defined, we return the our type as an array of these elements.

Specified by:

getParamInfo in class DynamicParamDescriptor