Package com.ptc.windchill.enterprise.change2.mvc.builders.tables

Class ResultingItemsTableBuilder

java.lang.Object

com.ptc.mvc.components.AbstractComponentConfigBuilder

com.ptc.mvc.components.AbstractComponentBuilder

com.ptc.windchill.enterprise.change2.mvc.builders.tables.AbstractChangeTableBuilder

com.ptc.windchill.enterprise.change2.mvc.builders.tables.AbstractAffectedAndResultingItemsTableBuilder

com.ptc.windchill.enterprise.change2.mvc.builders.tables.ResultingItemsTableBuilder

All Implemented Interfaces:

ConfigurableTableBuilder, ComponentConfigBuilder, com.ptc.mvc.components.ComponentConfigFactoryAware, ComponentDataBuilder, ComponentDataBuilderAsync

@TypeBased("wt.change2.ChangeActivity2")
@ComponentBuilder("changeTask.resultingItemsTable")
public class ResultingItemsTableBuilder
extends com.ptc.windchill.enterprise.change2.mvc.builders.tables.AbstractAffectedAndResultingItemsTableBuilder
implements ConfigurableTableBuilder

Specifies the configuration and populates the data in order to display the change task resulting objects table.

The resulting table can be configured to have a different table id, label, view, row actions and tool bar actions by specifying additional request parameters when requesting to display the table. The following additional request parameters are supported:

• resultingTableId
• resultingLabel

Example:
<action name="affectedAndResultingItems" id="affectedAndResultingItems">
<component name="changeTask.resultingItemsTable" typeBased="true" urlParams= "resultingTableId=reviewTask.resultingItems&resultingLabel=com.ptc.windchill.enterprise.change2.change2ClientResource.REVIEW_RESULTING_ITEMS_TABLE" />
</action>
A new registered table view class and action models will need to be registered for the new resulting table id. The tool bar and object actions are configured through a convention of using the table id as a prefix plus ".table.view" for tool bar actions and ".row.actions.view" for row actions as the name of the action model. If the action model for the row action does not exist, the default action model for the row object type will be used.

Example:
<model name="reviewTask.resultingItems.table.view">
<action name="list_copy" type="object" shortcut="true"/>
<action name="viewEffectivity" type="effectivity" shortcut="true"/>
<action name="separator" type="separator"/>
<action name="launchStructureCompareForChange" type="change"/>
<submodel name="exportlisttofile_submenu" type="object"/>
</model>


Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
ComponentConfig	buildComponentConfig(ComponentParams params)	Describes the change task affected objects table.
Object	buildComponentData(ComponentConfig config, ComponentParams params)	Given the params returns the affected data by calling the ChangeItemQueryCommands.getAffectedData(com.ptc.netmarkets.util.beans.NmCommandBean) method.

Methods inherited from class com.ptc.windchill.enterprise.change2.mvc.builders.tables.AbstractAffectedAndResultingItemsTableBuilder

buildClientFeedBacks

Methods inherited from class com.ptc.windchill.enterprise.change2.mvc.builders.tables.AbstractChangeTableBuilder

addToClientFeedBacks, buildComponentData, getActionsPrefix, getChangeableLabel, getChangeableTableId, getRowActionsPrefix

Methods inherited from class com.ptc.mvc.components.AbstractComponentConfigBuilder

getComponentConfigFactory, getMessageSource, setComponentConfigFactory

Methods inherited from class java.lang.Object

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

Method Details

buildComponentData

public Object buildComponentData(ComponentConfig config,
 ComponentParams params)
                          throws Exception

Given the params returns the affected data by calling the ChangeItemQueryCommands.getAffectedData(com.ptc.netmarkets.util.beans.NmCommandBean) method.

Supported API: true

Specified by:

buildComponentData in interface ComponentDataBuilder

Parameters:

config -

params -

Returns:

A ComponentData or a supported raw object type

Throws:

Exception

See Also:

• ChangeItemQueryCommands

buildComponentConfig

public ComponentConfig buildComponentConfig(ComponentParams params)
                                     throws WTException

Describes the change task affected objects table. The following columns property are added to the table config:

"statusFamily_General"

"statusFamily_Share"

"statusFamily_Change"

"launchIncorpHangingChange"

"change_tableData"

"supportAnnotations"

"infoPageAction"

"nmActions"

"name"

"lifeCycleState"

"thePersistInfo.modifyStamp"

"modifier.name"

"crDescription"

"HangingChangeLinkData"

Supported API: true

Specified by:

buildComponentConfig in interface ComponentConfigBuilder

Parameters:

params -

Returns:

Throws:

WTException