com.ptc.windchill.enterprise.change2.tags
Class ChangeWizardInitializeTag

java.lang.Object
  SimpleTagSupport
      com.ptc.windchill.enterprise.change2.tags.ChangeWizardInitializeTag

public class ChangeWizardInitializeTag
extends SimpleTagSupport

The ChangeWizardInitializeTag class is used by all of the common change management wizards and tables to track various states of the change client.

Current states being monitored include:

Tag parameter	Description	Object Type
changeItemClass	The class interface of the wizard, used in querying for the related changes relationships. Valid values are wt.change2.ChangeRequestIfc or wt.changd2.ChangeOrderIfc	java.lang.String
changeMode	The ComponentMode of the client. Valid values are: CREATE EDIT, or VIEW.	java.lang.String
annotationUIContext	The UI Context used by the annotation tables. Valid values are: change or part.	java.lang.String
varianceEffectivity	Whether variance effectivity is supported. Valid values are: true or false.	java.lang.String


The tag is declared and used by each of the create/edit wizards in conjunction with the bean class com.ptc.windchill.enterprise.change2.beans.ChangeWizardBean to remember the state of the wizard. An instance of the com.ptc.windchill.enterprise.change2.beans.ChangeWizardBean is required to be initialized prior to using this tag class. When the tag is initialized the parameters are set on the bean, as well as put into the HTML response through hidden input fields.

Supported API: true

Extendable: false

Method Summary

void	doTag() This is the required method to process the tag in the JSP page.
String	getAnnotationUIContext() Method to get the annotationUIContext from the tag state.
String	getChangeItemClass() Method to get the changeItemClass from the tag state.
String	getChangeMode() Method to get the current mode from the tag state.
String	getVarianceEffectivity() Method to get the varianceEffectivity from the tag state.
void	setAnnotationUIContext(String uicontext) Method to set the annotationUIContext tag parameter.
void	setChangeItemClass(String changeClass) Method to set the changeItemClass tag parameter.
void	setChangeMode(String mode) Method to set the mode.
void	setVarianceEffectivity(String varEff) Method to set the variance effectivity tag parameter.

Methods inherited from class java.lang.Object

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

Method Detail

setChangeMode

public void setChangeMode(String mode)
                   throws JspException

Method to set the mode. If the mode is not a valid string representing a com.ptc.core.ui.resources.ComponentMode Enum, a JspException will be thrown by the tag class.

Supported API: true

Parameters:

mode - The text value of the Enum representing the mode.

Throws:

JspException - If the text value could not be parsed to a valid ComponentMode object.

See Also:

ComponentMode

getChangeMode

public String getChangeMode()

Method to get the current mode from the tag state.

Supported API: true

Returns:

The current wizard change mode or null if not defined.

setChangeItemClass

public void setChangeItemClass(String changeClass)
                        throws JspException

Method to set the changeItemClass tag parameter. The parameter can only be set to one of the valid values as defined in the class documentation.

Supported API: true

Parameters:

changeClass - The change class to set on the tag class.

Throws:

JspException - if the changeClass is not wt.change2.ChangeRequestIfc or wt.change2.ChangeOrderIfc

getChangeItemClass

public String getChangeItemClass()

Method to get the changeItemClass from the tag state.

Supported API: true

Returns:

The current changeItemClass set in the tag class, or null if not defined.

setVarianceEffectivity

public void setVarianceEffectivity(String varEff)
                            throws JspException

Method to set the variance effectivity tag parameter. The parameter can only be set to one of the valid values as defined in the class documentation.

Supported API: true

Parameters:

varEff - The value to set the variance effectivity to.

Throws:

JspException - if the varEff is not true or false

getVarianceEffectivity

public String getVarianceEffectivity()

Method to get the varianceEffectivity from the tag state.

Supported API: true

Returns:

The current varianceEffectivity set in the tag class.

setAnnotationUIContext

public void setAnnotationUIContext(String uicontext)
                            throws JspException

Method to set the annotationUIContext tag parameter. The parameter can only be set to one of the valid values as defined in the class documentation.

Supported API: true

Parameters:

uicontext - The annotationUIContext to set on the tag class.

Throws:

JspException - if the uicontext is not change or part

getAnnotationUIContext

public String getAnnotationUIContext()

Method to get the annotationUIContext from the tag state.

Supported API: true

Returns:

The current annotationUIContext set in the tag class.

doTag

public void doTag()
           throws JspException

This is the required method to process the tag in the JSP page. If the page does not contain an instantiated com.ptc.windchill.enterprise.change2.beans.ChangeWizardBean object, an exception will be thrown and processing of the tag will cease. All values defined in the tag will be set in the changeWizardBean as well as be put into the body of the JSP Response stream as hidden fields. The hidden field form elements will use the tag parameter names as their ids.

Supported API: true

Throws:

JspException - If the wizard bean is not initialized, the response stream is already committed or upon any other processing error.