com.ptc.windchill.enterprise.change2.beans
Class ChangeWizardBean

java.lang.Object
  com.ptc.windchill.enterprise.change2.beans.ChangeWizardBean

All Implemented Interfaces:

Serializable

public class ChangeWizardBean
extends Object
implements Serializable

The ChangeWizardBean class is used by all of the common change management wizards as a container bean for maintaining the configured state of the client for the given request. The bean should only be used with a scope of "request" by the JSP context.
A JSP can declare a usage of this bean with the following syntax:

<jsp:useBean id="changeWizardBean" class="com.ptc.windchill.enterprise.change2.beans.ChangeWizardBean" scope="request"> lt;jsp:setProperty name="changeWizardBean" property="request" value="${pageContext.request}"/> </jsp:useBean>

Of note is the setting of the current HTTPRequest into the bean. This is used to check for any values contained in the FORM data when accessing the get() methods.

The tag class com.ptc.windchill.enterprise.change2.tags.ChangeWizardInitializeTag is used to setup the bean in the top-most JSP page (such as a create.jsp file).

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

String	getAnnotationUIContext() Gets the annotation UI Context from the bean.
String	getChangeItemClass() Gets the change item class from the bean.
String	getChangeMode() Gets the change mode from the bean.
HttpServletRequest	getRequest() Retrieves the current HttpServletRequest from the Bean.
String	getVarianceEffectivity() Gets the variance effectivity from the bean.
void	setAnnotationUIContext(String context) Set the annotation UI Context in the bean.
void	setChangeItemClass(String parameter) Set the change Item class in the bean.
void	setChangeMode(String mode) Set the change mode for the bean.
void	setRequest(HttpServletRequest theRequest) Set the request object in the bean.
void	setVarianceEffectivity(String varEff) Set the variance effectivity value in the bean.

Methods inherited from class java.lang.Object

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

Method Detail

setRequest

public void setRequest(HttpServletRequest theRequest)

Set the request object in the bean. The Request is used to obtain the FORM data to look for a FORM perssited bean value if the bean value is null. This method is typically called from within the jsp:useBean construct.

Supported API: true

Parameters:

theRequest - The current HttpServletRequest object

getRequest

public HttpServletRequest getRequest()

Retrieves the current HttpServletRequest from the Bean.

Supported API: true

Returns:

The current HttpServletRequest object in the bean.

getChangeMode

public String getChangeMode()

Gets the change mode from the bean. If the change mode is not initialized in the bean, it will attempt to find the value from the request data. If the value is not in the request data it will be initialized to "VIEW".

Supported API: true

Returns:

the change mode for the bean.

setChangeMode

public void setChangeMode(String mode)

Set the change mode for the bean. The change mode should be one of the modes defined by the com.ptc.core.ui.resources.ComponentMode class or a warning will be thrown (meaning null will be set).

Supported API: true

Parameters:

mode - the change mode to set in the bean.

getVarianceEffectivity

public String getVarianceEffectivity()

Gets the variance effectivity from the bean. If the variance effectivity is not initialized in the bean, it will attempt to find the value from the request data. If the value is not in the request data it will be initialized to null.

Supported API: true

Returns:

the variance effectivity value (true | false | null)

setVarianceEffectivity

public void setVarianceEffectivity(String varEff)

Set the variance effectivity value in the bean. Currently no validation of the value is conducted for a valid value. See parameters for values that are supported.

Supported API: true

Parameters:

varEff - the variance effectivity to set. Should be either (true | false | null)

getAnnotationUIContext

public String getAnnotationUIContext()

Gets the annotation UI Context from the bean. If the annotation UI Context is not initialized in the bean, it will attempt to find the value from the request data. If the value is not in the request data it will be initialized to null.

Supported API: true

Returns:

the annotation UI Context value ( change | affectedData | miniinfo | null )

setAnnotationUIContext

public void setAnnotationUIContext(String context)

Set the annotation UI Context in the bean. Currently no validation of the value is conducted for a valid value. See parameters for values that are supported.

Supported API: true

Parameters:

context - the annotation UI Context to set. Can be either ( change | affectedData | miniinfo | null )

getChangeItemClass

public String getChangeItemClass()

Gets the change item class from the bean. If the change item class is not initialized in the bean, it will attempt to find the value from the request data. If the value is not in the request data it will be initialized to null.

Supported API: true

Returns:

the change item class (wt.change2.ChangeOrderIfc | wt.change2.ChangeRequestIfc | null )

setChangeItemClass

public void setChangeItemClass(String parameter)

Set the change Item class in the bean. Currently no validation of the value is conducted for a valid value. See parameters for values that are supported.

Supported API: true

Parameters:

parameter - the change item class to set. Should be either (wt.change2.ChangeOrderIfc | wt.change2.ChangeRequestIfc | null )