com.ptc.windchill.cadx.checkin
Class CheckinURLActionDelegate

java.lang.Object
  com.ptc.windchill.cadx.common.BasicWildfireNavBarActionDelegate
      com.ptc.windchill.cadx.checkin.CheckinActionDelegate
          com.ptc.windchill.cadx.checkin.CheckinURLActionDelegate

All Implemented Interfaces:

ActionDelegate, NavBarActionDelegate, NavBarURLActionDelegate, URLActionDelegate, WildfireActionDelegate, WildfireNavBarCommonActionDelegate, WildfireNavBarCommonURLActionDelegate, WildfireURLActionDelegate

public class CheckinURLActionDelegate

extends CheckinActionDelegate

implements WildfireNavBarCommonURLActionDelegate

Supported API: true

Extendable: false

Field Summary

private String	actionName
private static String	CLASSNAME
private String	classURL
protected NavBarURLActionDelegateHelper	helper
private static String	RESOURCE

Fields inherited from class com.ptc.windchill.cadx.checkin.CheckinActionDelegate

CONTEXT_SERVICE_NAME, standAloneEnabled

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

state

Fields inherited from interface wt.enterprise.URLActionDelegate

ACTION_NAME, CLASS_URL

Constructor Summary

CheckinURLActionDelegate()

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.
boolean	isURLProvider(HashMap queryValueMap, Object object) 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.
void	setMethod(String method) Deprecated.
void	setResourceBundleStr(String resourceBundle) Sets the name of the fully qualified classname of the resource bundle to use.
void	setResourceKey(String key) Sets the integer reference of the entry to use in the Resource Bundle specified be the getResourceBundleStr call Supported API: false Supported API: false Supported API: false
void	setState(HTTPState state) Sets the value of the current HTTPState object being used in the current TemplateProcessor Supported API: false Supported API: false Supported API: false
String	URL(Object object) Deprecated.
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.checkin.CheckinActionDelegate

enableable, getContextServiceName, setContextServiceName, valid

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

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

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

helper

protected NavBarURLActionDelegateHelper helper

Constructor Detail

CheckinURLActionDelegate

public CheckinURLActionDelegate()

Method Detail

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

URL

public String URL(Object object)
           throws WTException

Deprecated.

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: true

Specified by:

URL in interface URLActionDelegate

Parameters:

object -

Returns:

String

Throws:

WTException

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

isURLProvider

public boolean isURLProvider(HashMap queryValueMap,
                             Object object)

Deprecated.

Returns boolean flag indicating if the the current HashMap of name values pairs from the QueryString was generated by the current NavBarURLActionDelegate.

Supported API: true

Specified by:

isURLProvider in interface NavBarURLActionDelegate

Parameters:

queryValueMap - The Name-Value pairs from the Query String

object - The target object used to generate the Url

Returns:

boolean

setResourceKey

public void setResourceKey(String key)

Sets the integer reference of the entry to use in the Resource Bundle specified be the getResourceBundleStr call

Supported API: false

Supported API: false

Supported API: false

Specified by:

setResourceKey in interface NavBarURLActionDelegate

Parameters:

key - The integer value of the key in the resource bundle to use to generate localized label for the link

setResourceBundleStr

public void setResourceBundleStr(String resourceBundle)

Sets the name of the fully qualified classname of the resource bundle to use. This will be the resource bundle used to generate the localized text used for the getURLLabel method.

Supported API: false

Supported API: false

Supported API: false

Specified by:

setResourceBundleStr in interface NavBarURLActionDelegate

Parameters:

resourceBundle - The target resource bundle to use generate localized label for the link

setState

public void setState(HTTPState state)

Sets the value of the current HTTPState object being used in the current TemplateProcessor

Supported API: false

Supported API: false

Supported API: false

Specified by:

setState in interface NavBarURLActionDelegate

Overrides:

setState in class BasicWildfireNavBarActionDelegate

Parameters:

state - The current HTTPState instance

Returns:

void

setMethod

public void setMethod(String method)

Deprecated.

Sets the method in URLAction to specify on the URL

Supported API: true

Specified by:

setMethod in interface NavBarURLActionDelegate

Parameters:

method - Name of a Gateway Method from URLProcessor