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

Class AffectedDataTableBuilder

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

All Implemented Interfaces:

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

@TypeBased("wt.change2.VersionableChangeItem")
@ComponentBuilder("changemanagement.affecteddatatable")
public class AffectedDataTableBuilder
extends com.ptc.windchill.enterprise.change2.mvc.builders.tables.AbstractAffectedAndResultingItemsTableBuilder
implements ConfigurableTableBuilder

Builder for the Problem Report, Change Request and Variance Affected Objects table.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
ComponentConfig	buildComponentConfig(ComponentParams params)	Describes the 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.
protected String	getHelpLink(String tableId, ComponentMode mode)	Gets the affected data table help link id.
protected String	getRowActionModel(String tableId, ComponentMode mode)	Gets the affected data table row action model.
protected String	getTableActionModel(String tableId, ComponentMode mode)	Gets the affected data table action model.
protected String	getTableId(String oidString, String ItemClass)	Gets the affected data table id.
protected boolean	isCreateEditMode(ComponentMode mode)	Checks if component mode is create or edit.

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

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 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"

"associatedAnnotations"

"change_approvedQuantity"

"aiDescription"

Supported API: true

Specified by:

buildComponentConfig in interface ComponentConfigBuilder

Parameters:

params -

Returns:

Throws:

WTException

getTableId

protected String getTableId(String oidString,
 String ItemClass)
                     throws WTException

Gets the affected data table id. Will return the issues table id if ItemClass and oidString are not defined.

Supported API: true

Parameters:

The - oid string

The - change item class

Returns:

The table id

Throws:

WTException

isCreateEditMode

protected boolean isCreateEditMode(ComponentMode mode)

Checks if component mode is create or edit.

Supported API: true

Parameters:

The - component mode

Returns:

True if mode is create or edit, false otherwise

getTableActionModel

protected String getTableActionModel(String tableId,
 ComponentMode mode)

Gets the affected data table action model. This model hold actions that appear on the table toolbar. Will return the change request action model if table id is not defined

Supported API: true

Parameters:

The - table id

The - component mode

Returns:

The table action model id

getRowActionModel

protected String getRowActionModel(String tableId,
 ComponentMode mode)

Gets the affected data table row action model. This model hold actions that appear when the table row data is right clicked. Will return the change request row action model if table id is not defined

Supported API: true

Parameters:

The - table id

The - component mode

Returns:

The row action model id

getHelpLink

protected String getHelpLink(String tableId,
 ComponentMode mode)

Gets the affected data table help link id.

Supported API: true

Parameters:

The - table id

The - component mode

Returns:

The help link id