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

Class AffectedItemsTableBuilder

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.AffectedItemsTableBuilder

All Implemented Interfaces:

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

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

Builder for the Change Task Affected Objects table.

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.
ConfigurableTable	buildConfigurableTable(String id)	Returns the ConfigurableTable for the component invalid input: '<' Supported API: true
protected boolean	enableDispositionComments()	Enables the disposition comments attribute on the set disposition picker.
List<String>	getDispositionComponentIds()	Returns the list of supported disposition component ids.

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, getBaseActionPrefix, getBaseTableID, getChangeableLabel, getChangeableTableId, getDefaultTableTitle, 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

buildConfigurableTable

public ConfigurableTable buildConfigurableTable(String id)
                                         throws WTException

Returns the ConfigurableTable for the component
invalid input: '<'

Supported API: true

Specified by:

buildConfigurableTable in interface ConfigurableTableBuilder

Parameters:

id -

Returns:

Throws:

WTException

buildComponentData

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

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:

WTException

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"

"change_tableData"

"supportAnnotations"

"infoPageAction"

"nmActions"

"name"

"lifeCycleState"

"thePersistInfo.modifyStamp"

"modifier.name"

"aiDescription"

"changeIntent"

"associatedAnnotations"

disposition columns see getDispositionComponentIds()

Supported API: true

Specified by:

buildComponentConfig in interface ComponentConfigBuilder

Parameters:

params -

Returns:

Throws:

WTException

enableDispositionComments

protected boolean enableDispositionComments()

Enables the disposition comments attribute on the set disposition picker. The default is that the set disposition comments is enabled.

Supported API: true

Returns:

true to enable the set disposition comments.

getDispositionComponentIds

public List<String> getDispositionComponentIds()

Returns the list of supported disposition component ids. The default supported disposition component ids are:

Component Id	Attribute Name
onOrderDisposition	theOnOrderDisposition
inventoryDisposition	theInventoryDisposition
finishDisposition	theFinishDisposition

Supported API: true

Returns:

list of disposition component ids