com.ptc.windchill.cadx.autopart
Class AutoPartURLActionDelegate

java.lang.Object
  com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate
      com.ptc.windchill.cadx.autopart.AutoPartActionDelegate
          com.ptc.windchill.cadx.autopart.AutoPartURLActionDelegate

All Implemented Interfaces:

ActionDelegate, NavBarActionDelegate, URLActionDelegate, WildfireActionDelegate, WildfireNavBarCommonActionDelegate, WildfireURLActionDelegate

public class AutoPartURLActionDelegate

extends AutoPartActionDelegate

implements WildfireURLActionDelegate

Supported API: true

Extendable: false

Field Summary

private String	actionName
private static String	CLASSNAME
private String	classURL
private static String	RESOURCE

Fields inherited from class com.ptc.windchill.cadx.autopart.AutoPartActionDelegate

CONTEXT_SERVICE_NAME

Fields inherited from class com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate

state

Fields inherited from interface wt.enterprise.URLActionDelegate

ACTION_NAME, CLASS_URL

Constructor Summary

AutoPartURLActionDelegate()

Method Summary

private void	actionNameValidate(String a_ActionName)
private void	classURLValidate(String a_ClassURL)
String	getActionName() Gets the value of the attribute: actionName; The value to use when constructing the "action" query parameter for the url that is returned when calling the URL(Object object) method.
String	getClassURL() Gets the value of the attribute: classURL.
String	getURLLabel(Locale locale) Deprecated.
void	setActionName(String a_ActionName) Sets the value of the attribute: actionName; The value to use when constructing the "action" query parameter for the url that is returned when calling the URL(Object object) method.
void	setClassURL(String a_ClassURL) Sets the value of the attribute: classURL.
String	URL(Object object) Returns a URL which when selected will perform the action on the object.
String	URL(Object object, HTTPState state) Returns a URL which, when selected, will perform the action on the object.

Methods inherited from class com.ptc.windchill.cadx.autopart.AutoPartActionDelegate

enableable, getContextServiceName, setContextServiceName, valid

Methods inherited from class com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate

enableable, enableable, getContextWorkspace, getIsValidInInActive, getNeverInStandAlone, setContextWorkspace, setIsValidInInActive, setNeverInStandAlone, setState

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

actionName

private String actionName

classURL

private String classURL

Constructor Detail

AutoPartURLActionDelegate

public AutoPartURLActionDelegate()

Method Detail

URL

public String URL(Object object)
           throws WTException

Returns a URL which when selected will perform the action on the object. This method should not be called when the concrete URLActionDelegate class is unknown. In that case, call BasicTemplateProcessor.getURLFromDelegate() instead.

Supported API: false

Specified by:

URL in interface URLActionDelegate

Parameters:

object -

Returns:

String

Throws:

WTException

URL

public String URL(Object object,
                  HTTPState state)
           throws WTException

Returns a URL which, when selected, will perform the action on the object. This implementation of the method considers the origin of the HTTPRequest (user agent) and is the one that should be used for all classes implementing the WildfireURLActionDelegate interface. The method URL(Object) is not valid for objects implementing WildfireActionDelegate and will throw an exception.

Supported API: false

Specified by:

URL in interface WildfireURLActionDelegate

Parameters:

object -

state -

Returns:

String

Throws:

WTException

getActionName

public String getActionName()

Gets the value of the attribute: actionName; The value to use when constructing the "action" query parameter for the url that is returned when calling the URL(Object object) method.

Supported API: true

Specified by:

getActionName in interface URLActionDelegate

Returns:

String

setActionName

public void setActionName(String a_ActionName)
                   throws WTPropertyVetoException

Sets the value of the attribute: actionName; The value to use when constructing the "action" query parameter for the url that is returned when calling the URL(Object object) method.

Supported API: true

Specified by:

setActionName in interface URLActionDelegate

Overrides:

setActionName in class BasicWildfireNavBarActionDelegate

Parameters:

a_ActionName -

Returns:

void

Throws:

WTPropertyVetoException

actionNameValidate

private void actionNameValidate(String a_ActionName)
                         throws WTPropertyVetoException

Parameters:

a_ActionName -

Throws:

WTPropertyVetoException

getClassURL

public String getClassURL()

Gets the value of the attribute: classURL.

Supported API: false

Specified by:

getClassURL in interface URLActionDelegate

Returns:

String

setClassURL

public void setClassURL(String a_ClassURL)
                 throws WTPropertyVetoException

Sets the value of the attribute: classURL.

Supported API: false

Specified by:

setClassURL in interface URLActionDelegate

Parameters:

a_ClassURL -

Throws:

WTPropertyVetoException

classURLValidate

private void classURLValidate(String a_ClassURL)
                       throws WTPropertyVetoException

Parameters:

a_ClassURL -

Throws:

WTPropertyVetoException

getURLLabel

public String getURLLabel(Locale locale)

Deprecated.

Returns a localized label for a URL for the actions.

Supported API: true

Specified by:

getURLLabel in interface URLActionDelegate

Parameters:

locale -

Returns:

String