Package com.ptc.windchill.enterprise.revise.processors.handler

Class DefaultRevisionJSDataHandler

java.lang.Object

com.ptc.windchill.enterprise.revise.processors.handler.RevisionJSDataHandler

com.ptc.windchill.enterprise.revise.processors.handler.DefaultRevisionJSDataHandler

All Implemented Interfaces:

com.ptc.core.htmlcomp.jstable.JSDataHandler

public class DefaultRevisionJSDataHandler
extends RevisionJSDataHandler

Data handler for the "New Revision" column in the revise wizard.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
com.ptc.core.htmlcomp.jstable.JSPropertyValue	getNewRevisionJSData(String attribute, Locale locale, Object object, com.ptc.core.htmlcomp.jstable.JSDataObject rowobj)	Handles the New Revision Column value.
com.ptc.core.htmlcomp.jstable.JSPropertyValue	getRevisionOverrideAllowedJSData(String attribute, Locale locale, Object object, com.ptc.core.htmlcomp.jstable.JSDataObject rowobj)	Checks if user is allowed to override the New Revision Column value.
void	init(String attribute, Locale locale, List dataObjects)	Using the list of row objects initializes a map revisionPrefMasterList that stores the row object as a key and the override revision label preference as the value.
boolean	isRevisionOverrideAllowed(Versioned object, WTUser user)	Checks if an object and the current user is allowed to override the New Revision Column value.

Methods inherited from class com.ptc.windchill.enterprise.revise.processors.handler.RevisionJSDataHandler

getJSPropertyValue

Methods inherited from class java.lang.Object

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

Method Details

init

public void init(String attribute,
 Locale locale,
 List dataObjects)
          throws WTException

Using the list of row objects initializes a map revisionPrefMasterList that stores the row object as a key and the override revision label preference as the value.

Supported API: true

Parameters:

attribute -

locale -

dataObjects - The list of row objects.

Throws:

WTException

getNewRevisionJSData

public com.ptc.core.htmlcomp.jstable.JSPropertyValue getNewRevisionJSData(String attribute,
 Locale locale,
 Object object,
 com.ptc.core.htmlcomp.jstable.JSDataObject rowobj)
                                                                   throws WTException

Handles the New Revision Column value.

Supported API: true

Specified by:

getNewRevisionJSData in class RevisionJSDataHandler

Parameters:

attribute -

locale -

object - The row object.

rowobj - The row object.

Returns:

The string property value JSStringPropertyValue for the new revision column.

Throws:

WTException

getRevisionOverrideAllowedJSData

public com.ptc.core.htmlcomp.jstable.JSPropertyValue getRevisionOverrideAllowedJSData(String attribute,
 Locale locale,
 Object object,
 com.ptc.core.htmlcomp.jstable.JSDataObject rowobj)
                                                                               throws WTException

Checks if user is allowed to override the New Revision Column value.

Supported API: true

Specified by:

getRevisionOverrideAllowedJSData in class RevisionJSDataHandler

Parameters:

attribute -

locale -

object - The row object.

rowobj - The row object.

Returns:

The boolean property value JSBooleanPropertyValue for the new revision column.

Throws:

WTException

isRevisionOverrideAllowed

public boolean isRevisionOverrideAllowed(Versioned object,
 WTUser user)
                                  throws WTException

Checks if an object and the current user is allowed to override the New Revision Column value. If the "/com/ptc/revisionLabelReviseOverride" preference is set to "True" in the container of the object the Revision column can select a different revision label than then next in the series.

Supported API: true

Parameters:

object - The row object.

user - The current user.

Returns:

True when the user is allowed to override the revision label.

Throws:

WTException