atg.droplet
Class ArrayElementParamDescriptor

java.lang.Object
  java.beans.FeatureDescriptor
      atg.beans.SerializableFeatureDescriptor
          atg.droplet.ParamDescriptor
              atg.droplet.DynamicParamDescriptor
                  atg.droplet.ArrayElementParamDescriptor

All Implemented Interfaces:

java.io.Serializable

public class ArrayElementParamDescriptor
extends DynamicParamDescriptor

This is a dynamic ParamDescriptor which allows you to define an output parameter whose type is an element of an array based input parameter.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.beans.SerializableFeatureDescriptor

BUNDLE_ATTRIBUTE_NAME, LOCALE_ATTRIBUTE_NAME

Constructor Summary

ArrayElementParamDescriptor()

ArrayElementParamDescriptor(java.lang.String pName, java.lang.String pDescription, java.lang.Class pParamClass, boolean pOptional, boolean pLocal, java.lang.String pArrayParamName)
Construct an ArrayElementParamDescriptor.

Method Summary

java.lang.String	getArrayParamName()
ObjectTypeInfo	getParamInfo(ParamDescriptorResolver pResolver) Returns the type of the parameter by first getting the type of the input parameter.
void	setArrayParamName(java.lang.String pArrayParamName) Sets the property ArrayParamName.

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, getDisplayName, getDisplayNameResource, getDisplaySortString, 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

ArrayElementParamDescriptor

public ArrayElementParamDescriptor()

ArrayElementParamDescriptor

public ArrayElementParamDescriptor(java.lang.String pName,
                                   java.lang.String pDescription,
                                   java.lang.Class pParamClass,
                                   boolean pOptional,
                                   boolean pLocal,
                                   java.lang.String pArrayParamName)

Construct an ArrayElementParamDescriptor. Most of these arguments are the same as those to ParamDescriptor. The last argument, pArrayParamName, is the name of the input parameter that we should base our output parameter's type on.

Method Detail

setArrayParamName

public void setArrayParamName(java.lang.String pArrayParamName)

Sets the property ArrayParamName. This is the name of the input parameter that we should base our output parameter's type on.

getArrayParamName

public java.lang.String getArrayParamName()

Returns:

The value of the property ArrayParamName.

getParamInfo

public ObjectTypeInfo getParamInfo(ParamDescriptorResolver pResolver)

Returns the type of the parameter by first getting the type of the input parameter. If this type is known, and it is known to be an array, we return our type as the component type of that array.

Specified by:

getParamInfo in class DynamicParamDescriptor