com.bowstreet.webapp
Interface PageDataContainer

All Superinterfaces:
DataDefinitionContainer, DataDefinitionElement, PageDataElement
All Known Implementing Classes:
Container, PageReference

public interface PageDataContainer
extends PageDataElement, DataDefinitionContainer

PageDataContainer.java

Author:
szagieboylo Copyright (c) 2004 Bowstreet, Inc. Interface for PageDataContainer. The PageData hierarchy represents the PageAutomation data as it is assigned to a page. A Container will have a list of children. A Leaf will never have children.

Field Summary
 
Fields inherited from interface com.bowstreet.webapp.DataDefinitionElement
DISPLAY_AUTO, DISPLAY_HORIZONTAL, DISPLAY_NO_VISIBLE, DISPLAY_NONE, DISPLAY_VERTICAL, KEY_ACTIONTYPE, KEY_ALWAYS_ADD_VALIDATION_CODE, KEY_APPEND_BAD_VALUE_TO_ERROR_MSG, KEY_ATTRIBUTES, KEY_COLUMN_SUMMARY, KEY_COLUMN_SUMMARY_ARGUMENT, KEY_COLUMN_SUMMARY_COLUMN1, KEY_COLUMN_SUMMARY_COLUMN2, KEY_COLUMN_SUMMARY_NODE, KEY_COLUMN_SUMMARY_OPERATION, KEY_COLUMN_SUMMARY_STANDARD_VARIABLE, KEY_COLUMN_SUMMARY_TEXTAFTER, KEY_COLUMN_SUMMARY_TEXTBEFORE, KEY_COLUMNALIGNMENT, KEY_COLUMNWIDTH, KEY_CREATE_ROW_METHOD, KEY_CREATE_ROW_METHODS, KEY_CUSTOMHIDELOCATION, KEY_DATA_SOURCE_MANAGER, KEY_DELETE_METHOD, KEY_DELETE_METHOD_TYPE, KEY_EMPTYDATAACTION, KEY_EMPTYDATAMESSAGE, KEY_EMPTYDATAMESSAGE_NAMEDLOCATION, KEY_EMPTYDATAMESSAGE_NODE, KEY_ERROR_MESSAGE_OVERRIDE, KEY_ESCAPEOUTPUTTEXT, KEY_FIELD_MERGE_DEFINITION, KEY_GENELEMENT, KEY_GENERATELABELS, KEY_HANDLEEXISTING, KEY_HAS_BEEN_RDD_PROCESSED, KEY_INFERCONTROLTYPE, KEY_IS_DATA_TRANSPARENT_CONTAINER, KEY_IS_POST_GENERATED_ELEMENT, KEY_IS_VISUALLY_TRANSPARENT_CONTAINER, KEY_ISMODELACTION, KEY_KEY_FIELD, KEY_LABELCLASS_ERROR, KEY_LABELCLASS_NOERROR, KEY_LABELTRANSLATETABLE, KEY_LABELTRANSLATEVARIABLE, KEY_LAYOUT_GRID, KEY_LOOKUP_TABLE, KEY_MODIFIERSLIST_DATAENTRY, KEY_MODIFIERSLIST_DISPLAYONLY, KEY_NO_ASSIGN_IF_VALIDATION_ERROR, KEY_ORIGINAL_DATASOURCE, KEY_PAGE_GENELEMENT, KEY_PUT_ASSIGN_IN_TRY_CATCH, KEY_RADIO_GROUP_STYLE_CLASS, KEY_RENDEROUTERPAGE, KEY_REQUIREDPROMPT, KEY_REQUIREDPROMPTPLACEMENT, KEY_RESOURCE_KEY_PREFIX, KEY_SELECT_OPTIONS, KEY_SEPARATOR, KEY_SPLIT_CHILDREN_INTO_COLUMNS, KEY_TRANSLATE_HTML_LABELS, KEY_UNIQUE_ID_LEVEL, KEY_USINGCHECKBOXES, KEY_VALIDATIONERRORPLACEMENT, KEY_VARIABLENAME, TYPE_ANYTYPE, TYPE_BOOLEAN, TYPE_BYTE, TYPE_DATE, TYPE_DATETIME, TYPE_DECIMAL, TYPE_DOUBLE, TYPE_FLOATINGPOINT, TYPE_INT, TYPE_INTEGER, TYPE_LONG, TYPE_NEGINT, TYPE_NONNEGINT, TYPE_NONPOSINT, TYPE_POSINT, TYPE_SHORT, TYPE_STRING, TYPE_TIME
 
Fields inherited from interface com.bowstreet.webapp.DataDefinitionElement
DISPLAY_AUTO, DISPLAY_HORIZONTAL, DISPLAY_NO_VISIBLE, DISPLAY_NONE, DISPLAY_VERTICAL, KEY_ACTIONTYPE, KEY_ALWAYS_ADD_VALIDATION_CODE, KEY_APPEND_BAD_VALUE_TO_ERROR_MSG, KEY_ATTRIBUTES, KEY_COLUMN_SUMMARY, KEY_COLUMN_SUMMARY_ARGUMENT, KEY_COLUMN_SUMMARY_COLUMN1, KEY_COLUMN_SUMMARY_COLUMN2, KEY_COLUMN_SUMMARY_NODE, KEY_COLUMN_SUMMARY_OPERATION, KEY_COLUMN_SUMMARY_STANDARD_VARIABLE, KEY_COLUMN_SUMMARY_TEXTAFTER, KEY_COLUMN_SUMMARY_TEXTBEFORE, KEY_COLUMNALIGNMENT, KEY_COLUMNWIDTH, KEY_CREATE_ROW_METHOD, KEY_CREATE_ROW_METHODS, KEY_CUSTOMHIDELOCATION, KEY_DATA_SOURCE_MANAGER, KEY_DELETE_METHOD, KEY_DELETE_METHOD_TYPE, KEY_EMPTYDATAACTION, KEY_EMPTYDATAMESSAGE, KEY_EMPTYDATAMESSAGE_NAMEDLOCATION, KEY_EMPTYDATAMESSAGE_NODE, KEY_ERROR_MESSAGE_OVERRIDE, KEY_ESCAPEOUTPUTTEXT, KEY_FIELD_MERGE_DEFINITION, KEY_GENELEMENT, KEY_GENERATELABELS, KEY_HANDLEEXISTING, KEY_HAS_BEEN_RDD_PROCESSED, KEY_INFERCONTROLTYPE, KEY_IS_DATA_TRANSPARENT_CONTAINER, KEY_IS_POST_GENERATED_ELEMENT, KEY_IS_VISUALLY_TRANSPARENT_CONTAINER, KEY_ISMODELACTION, KEY_KEY_FIELD, KEY_LABELCLASS_ERROR, KEY_LABELCLASS_NOERROR, KEY_LABELTRANSLATETABLE, KEY_LABELTRANSLATEVARIABLE, KEY_LAYOUT_GRID, KEY_LOOKUP_TABLE, KEY_MODIFIERSLIST_DATAENTRY, KEY_MODIFIERSLIST_DISPLAYONLY, KEY_NO_ASSIGN_IF_VALIDATION_ERROR, KEY_ORIGINAL_DATASOURCE, KEY_PAGE_GENELEMENT, KEY_PUT_ASSIGN_IN_TRY_CATCH, KEY_RADIO_GROUP_STYLE_CLASS, KEY_RENDEROUTERPAGE, KEY_REQUIREDPROMPT, KEY_REQUIREDPROMPTPLACEMENT, KEY_RESOURCE_KEY_PREFIX, KEY_SELECT_OPTIONS, KEY_SEPARATOR, KEY_SPLIT_CHILDREN_INTO_COLUMNS, KEY_TRANSLATE_HTML_LABELS, KEY_UNIQUE_ID_LEVEL, KEY_USINGCHECKBOXES, KEY_VALIDATIONERRORPLACEMENT, KEY_VARIABLENAME, TYPE_ANYTYPE, TYPE_BOOLEAN, TYPE_BYTE, TYPE_DATE, TYPE_DATETIME, TYPE_DECIMAL, TYPE_DOUBLE, TYPE_FLOATINGPOINT, TYPE_INT, TYPE_INTEGER, TYPE_LONG, TYPE_NEGINT, TYPE_NONNEGINT, TYPE_NONPOSINT, TYPE_POSINT, TYPE_SHORT, TYPE_STRING, TYPE_TIME
 
Method Summary
 PageDataContainer addPDContainerChild(java.lang.String name)
          create a new Container child
 PageDataLeaf addPDLeafChild(java.lang.String name)
          create a new Leaf child
 IXml getChildrenRepeatNode()
          Get the node upon which the repeat operation will be performed, if this is a repeated element
 java.lang.String getCounterVarName()
          get the variable name of the counter variable when this element is repeated
 java.lang.String getDeleteMethodName()
          get (or generate) the name of the generated method for deleting a row
 java.lang.String getPagingAssistantName()
          Get the name of the Paging Assistant that is associated with this Container.
 void setChildrenRepeatNode(IXml node)
          Set the node upon which the repeat operation will be performed, if this is a repeated element
 void setCounterVarName(java.lang.String name)
          Set the variable to be used as the loop counter
 
Methods inherited from interface com.bowstreet.webapp.PageDataElement
findPDChild, getAppliedDataSourceString, getDataSourceString, getLabelNode, getNode, getPage, getPDParent, hasInputFields, hasValidatedInputFields, isMatchedToPage, setDataSourceOverride, setLabelNode, setNode
 
Methods inherited from interface com.bowstreet.webapp.DataDefinitionElement
bestReadableName, findDDChild, getBooleanProperty, getBuilderCall, getDataSourceExtension, getDDParent, getDescription, getDisplayMode, getIntProperty, getIsRepeated, getIsRequired, getLabel, getName, getProperty, getShortLabel, getStringProperty, getType, getXmlProperty, putBothProperties, putLocalProperty, putProperty, setBuilderCall, setDataSourceExtension, setDescription, setDisplayMode, setIsRepeated, setIsRequired, setLabel, setShortLabel, setType
 
Methods inherited from interface com.bowstreet.webapp.DataDefinitionContainer
addChild, addDDContainerChild, addDDLeafChild, getChildren, getDataPagingPageSize, removeChild, setDataPagingPageSize
 
Methods inherited from interface com.bowstreet.webapp.DataDefinitionElement
bestReadableName, findDDChild, getBooleanProperty, getBuilderCall, getDataSourceExtension, getDDParent, getDescription, getDisplayMode, getIntProperty, getIsRepeated, getIsRequired, getLabel, getName, getProperty, getShortLabel, getStringProperty, getType, getXmlProperty, putBothProperties, putLocalProperty, putProperty, setBuilderCall, setDataSourceExtension, setDescription, setDisplayMode, setIsRepeated, setIsRequired, setLabel, setShortLabel, setType
 

Method Detail

addPDContainerChild

PageDataContainer addPDContainerChild(java.lang.String name)
create a new Container child

Parameters:
name -
Returns:
The new Container

addPDLeafChild

PageDataLeaf addPDLeafChild(java.lang.String name)
create a new Leaf child

Parameters:
name -
Returns:
The new Leaf

getChildrenRepeatNode

IXml getChildrenRepeatNode()
Get the node upon which the repeat operation will be performed, if this is a repeated element

Returns:
the node for repeating on

getCounterVarName

java.lang.String getCounterVarName()
get the variable name of the counter variable when this element is repeated

Returns:
The name of the Counter Variable

getDeleteMethodName

java.lang.String getDeleteMethodName()
get (or generate) the name of the generated method for deleting a row

Returns:
the name of the method for deleting a row

getPagingAssistantName

java.lang.String getPagingAssistantName()
Get the name of the Paging Assistant that is associated with this Container.

Returns:
Paging Assistant Name -- this might be null if there if no Pageing Assistant

setChildrenRepeatNode

void setChildrenRepeatNode(IXml node)
Set the node upon which the repeat operation will be performed, if this is a repeated element

Parameters:
node - the node for repeating on

setCounterVarName

void setCounterVarName(java.lang.String name)
Set the variable to be used as the loop counter

Parameters:
name -


Copyright © 2009 IBM. All Rights Reserved.