wt.eff
Class AddEffTaskDelegate

java.lang.Object
  extended bywt.templateutil.processor.FormTaskDelegate
      extended bywt.eff.AddEffTaskDelegate
All Implemented Interfaces:
ContextHolder
Direct Known Subclasses:
ChangeActivityAddEffTaskDelegate, ChangeOrderAddEffTaskDelegate, SetEffTaskDelegate

public class AddEffTaskDelegate
extends FormTaskDelegate

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release.

Supported API: false

Extendable: false


Field Summary
protected  ChangeActivityIfc authorizedBy
          Deprecated.  
private static String CLASSNAME
          Deprecated.  
protected  EffContext effContext
          Deprecated.  
protected  EffManagedVersion effManagedVersion
          Deprecated.  
private static String RESOURCE
          Deprecated.  
protected static boolean VERBOSE
          Deprecated.  
 
Fields inherited from class wt.templateutil.processor.FormTaskDelegate
 
Fields inherited from interface wt.templateutil.processor.ContextHolder
CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS
 
Constructor Summary
AddEffTaskDelegate()
          Deprecated.  
 
Method Summary
protected  EffGroup createEffGroup(String type_class, String eff_value, EffContext eff_context)
          Deprecated. Creates a new EffGroup from an EffContext, an Eff Type, and an Eff value.
 ChangeActivityIfc getAuthorizedBy()
          Deprecated. Returns the ChangeActivityIfc object authorizing the effectivity change.
 EffManagedVersion getContextEffManagedVersion()
          Deprecated. Returns the EffManagedVersion object which is the context object to which effectivity is being added.
protected  EffContext getEffContext(Properties context_params)
          Deprecated. Returns the EffContext object to be used in setting the effectivity.
static Persistable getObjectFromReference(String obj_reference)
          Deprecated. Converts the given String object reference into an object.
protected  void printHttpData()
          Deprecated. Outputs the Form data and Query data
 void processAction(ContentHTTPStream contentStream)
          Deprecated.  
 void setContextEffManagedVersion(EffManagedVersion eff_version)
          Deprecated. Sets the EffManagedVersion which is the context of this task delegate.
 
Methods inherited from class wt.templateutil.processor.FormTaskDelegate
addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, deleteFormDataFromSession, getContextAction, getContextClassName, getContextObj, getContextProperties, getFormData, getQueryData, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getState, getStatus, saveFormDataInSession, setContextAction, setContextClassName, setContextObj, setContextProperties, setFormData, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, switchPages
 
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
Deprecated. 
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME
Deprecated. 

VERBOSE

protected static boolean VERBOSE
Deprecated. 

effManagedVersion

protected EffManagedVersion effManagedVersion
Deprecated. 

effContext

protected EffContext effContext
Deprecated. 

authorizedBy

protected ChangeActivityIfc authorizedBy
Deprecated. 
Constructor Detail

AddEffTaskDelegate

public AddEffTaskDelegate()
Deprecated. 
Method Detail

processAction

public void processAction(ContentHTTPStream contentStream)
                   throws Exception
Deprecated.  

Processed the desired action and then updates the state so that the desired response page can be generated.

Use the addToResponse methods to pass back messages on the status/results of the action.

Supported API: false

Specified by:
processAction in class FormTaskDelegate
Parameters:
contentStream -
Throws:
Exception

createEffGroup

protected EffGroup createEffGroup(String type_class,
                                  String eff_value,
                                  EffContext eff_context)
                           throws WTException
Deprecated. 
Creates a new EffGroup from an EffContext, an Eff Type, and an Eff value. The EffContext, type and value are all given as String values.

Throws:
WTException

getObjectFromReference

public static Persistable getObjectFromReference(String obj_reference)
                                          throws WTException
Deprecated. 
Converts the given String object reference into an object. This method makes use of ReferenceFactory to convert the reference into an object.

Parameters:
obj_reference - the String reference to the object to be returned
Returns:
the WTObject converted from the given String reference
Throws:
if - an error occurs retrieving the object from the reference
WTException

getContextEffManagedVersion

public EffManagedVersion getContextEffManagedVersion()
                                              throws WTException
Deprecated. 
Returns the EffManagedVersion object which is the context object to which effectivity is being added.

Throws:
WTException

setContextEffManagedVersion

public void setContextEffManagedVersion(EffManagedVersion eff_version)
Deprecated. 
Sets the EffManagedVersion which is the context of this task delegate.

Parameters:
eff_version - the EffManagedVersion which is the context of this task delegate

getEffContext

protected EffContext getEffContext(Properties context_params)
                            throws WTException
Deprecated. 
Returns the EffContext object to be used in setting the effectivity.

Throws:
WTException

printHttpData

protected void printHttpData()
Deprecated. 
Outputs the Form data and Query data


getAuthorizedBy

public ChangeActivityIfc getAuthorizedBy()
                                  throws WTException
Deprecated. 
Returns the ChangeActivityIfc object authorizing the effectivity change.

Throws:
WTException