com.ptc.windchill.cadx.common
Class CommonProcessorService

java.lang.Object
  com.ptc.windchill.cadx.common.CommonProcessorService

All Implemented Interfaces:

ContextHolder, Externalizable, ProcessorService, Serializable

public class CommonProcessorService

extends Object

implements ProcessorService, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

protected static String	BLANK_SPACE
private static String	CLASSNAME
private static String	CODEBASE
static String	DEF_SOLTYPE_JS_VAR_NAME
static String	DEF_TRAIL_SYNC_DIV_ID
static String	DEF_TRAIL_SYNC_FORM_NAME
static String	DEF_USERAGENT_JS_VAR_NAME
static String	DOCUMENTATTRIBUTES
static long	EXTERNALIZATION_VERSION_UID
static String	GETSUPERCEDED
static String	JS_OBJ_DOUBLE_QUOTE
static String	JS_OBJ_SEMICOLON
static String	LINKATTRIBUTES
private static int	MAXLENGTH
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private HTTPState	theState
private static boolean	VERBOSE

Fields inherited from interface wt.templateutil.processor.ProcessorService

STATE

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

CommonProcessorService()

Method Summary

void	addToResponseExceptions(Exception newException) Deprecated.
void	addToResponseFooters(LocalizableMessage newFooter) Deprecated.
void	addToResponseHeaders(LocalizableMessage newHeader) Deprecated.
void	addToResponseMessages(LocalizableMessage newMessage) Deprecated.
boolean	doesProeSupportWC7()
void	genTrailSyncForm(Properties parameters, Locale locale, OutputStream os)
void	getCodebaseURLIntoJSSrc(Properties parameters, Locale locale, OutputStream os)
void	getContainerReferenceString(Properties parameters, Locale locale, OutputStream os) Get the container reference string (i.e.
String	getContextAction() Deprecated.
String	getContextClassName() Deprecated.
Object	getContextObj() Deprecated.
Properties	getContextProperties() Deprecated.
void	getCreateDialogWindowJS(Properties parameters, Locale locale, OutputStream os)
void	getDeleteLocalCacheNames(Properties parameters, Locale locale, OutputStream os)
Properties	getFormData() Deprecated.
void	getIcon(Properties parameters, Locale locale, OutputStream os)
void	getIsPDMLinkContext(Properties parameters, Locale locale, OutputStream os)
void	getIsProIContext(Properties parameters, Locale locale, OutputStream os)
void	getIsProjectLinkContext(Properties parameters, Locale locale, OutputStream os)
void	getJSSrc(Properties parameters, Locale locale, OutputStream os)
void	getObjStateHelperJSSrc(Properties parameters, Locale locale, OutputStream os)
private String	getOrgContextValue(String key)
void	getOrgDisplayFlag(Properties parameters, Locale locale, OutputStream os)
private PrintWriter	getPrintWriter(OutputStream out, Locale locale)
String	getProeDateCode()
Properties	getQueryData() Deprecated.
Vector	getResponseExceptions() Deprecated.
Vector	getResponseFooters() Deprecated.
Vector	getResponseHeaders() Deprecated.
Vector	getResponseMessages() Deprecated.
String	getResponseString() Deprecated.
private WTContainer	getSelectedOrWsContainer(HTTPState state, EPMWorkspace ws) Get selected container as selected in the pull-down (in case it has been changed).
void	getSerializedSolutionType(Properties parameters, Locale locale, OutputStream os)
HTTPState	getState() Gets the object for the association that plays role: theState.
int	getStatus() Deprecated.
void	getTitleWithIdentity(Properties parameters, Locale locale, OutputStream os)
void	getUserAgentIntoJSSrc(Properties parameters, Locale locale, OutputStream os)
void	isAutoNumberingEnabled(Properties parameters, Locale locale, OutputStream os)
private boolean	isContainerChanged() returns true if container has been changed in the container pull-down.
void	listOrganizationIDs(Properties parameters, Locale locale, OutputStream os)
void	printOrganizationFields(Properties parameters, Locale locale, OutputStream os)
void	printProEDateCode(Properties parameters, Locale locale, OutputStream os)
void	printProeWC7Support(Properties parameters, Locale locale, OutputStream os)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(CommonProcessorService thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContextAction(String a_ContextAction) Deprecated.
void	setContextClassName(String a_ContextClassName) Deprecated.
void	setContextObj(Object a_ContextObj) Deprecated.
void	setContextProperties(Properties a_ContextProperties) Deprecated.
void	setFormData(Properties a_FormData) Deprecated.
void	setQueryData(Properties a_QueryData) Deprecated.
void	setResponseExceptions(Vector a_ResponseExceptions) Deprecated.
void	setResponseFooters(Vector a_ResponseFooters) Deprecated.
void	setResponseHeaders(Vector a_ResponseHeaders) Deprecated.
void	setResponseMessages(Vector a_ResponseMessages) Deprecated.
void	setResponseString(String a_ResponseString) Deprecated.
void	setState(HTTPState a_State) Sets the object for the association that plays role: theState.
void	setStatus(int a_Status) Deprecated.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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

theState

private HTTPState theState

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

MAXLENGTH

private static int MAXLENGTH

BLANK_SPACE

protected static final String BLANK_SPACE

See Also:

Constant Field Values

CODEBASE

private static String CODEBASE

LINKATTRIBUTES

public static final String LINKATTRIBUTES

See Also:

Constant Field Values

DOCUMENTATTRIBUTES

public static final String DOCUMENTATTRIBUTES

See Also:

Constant Field Values

GETSUPERCEDED

public static final String GETSUPERCEDED

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

DEF_USERAGENT_JS_VAR_NAME

public static final String DEF_USERAGENT_JS_VAR_NAME

See Also:

Constant Field Values

DEF_SOLTYPE_JS_VAR_NAME

public static final String DEF_SOLTYPE_JS_VAR_NAME

See Also:

Constant Field Values

JS_OBJ_DOUBLE_QUOTE

public static final String JS_OBJ_DOUBLE_QUOTE

See Also:

Constant Field Values

JS_OBJ_SEMICOLON

public static final String JS_OBJ_SEMICOLON

See Also:

Constant Field Values

DEF_TRAIL_SYNC_FORM_NAME

public static final String DEF_TRAIL_SYNC_FORM_NAME

See Also:

Constant Field Values

DEF_TRAIL_SYNC_DIV_ID

public static final String DEF_TRAIL_SYNC_DIV_ID

See Also:

Constant Field Values

Constructor Detail

CommonProcessorService

public CommonProcessorService()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(CommonProcessorService thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getContextAction

public String getContextAction()

Deprecated.

Gets the value of the attribute: contextAction.

Supported API: false

Specified by:

getContextAction in interface ContextHolder

Returns:

String

setContextAction

public void setContextAction(String a_ContextAction)

Deprecated.

Sets the value of the attribute: contextAction.

Supported API: false

Specified by:

setContextAction in interface ContextHolder

Parameters:

a_ContextAction -

getContextObj

public Object getContextObj()

Deprecated.

Gets the value of the attribute: contextObj.

Supported API: false

Specified by:

getContextObj in interface ContextHolder

Returns:

Object

setContextObj

public void setContextObj(Object a_ContextObj)

Deprecated.

Sets the value of the attribute: contextObj.

Supported API: false

Specified by:

setContextObj in interface ContextHolder

Parameters:

a_ContextObj -

getContextClassName

public String getContextClassName()

Deprecated.

Gets the value of the attribute: contextClassName.

Supported API: false

Specified by:

getContextClassName in interface ContextHolder

Returns:

String

setContextClassName

public void setContextClassName(String a_ContextClassName)

Deprecated.

Sets the value of the attribute: contextClassName.

Supported API: false

Specified by:

setContextClassName in interface ContextHolder

Parameters:

a_ContextClassName -

getContextProperties

public Properties getContextProperties()

Deprecated.

Gets the value of the attribute: contextProperties.

Supported API: false

Specified by:

getContextProperties in interface ContextHolder

Returns:

Properties

setContextProperties

public void setContextProperties(Properties a_ContextProperties)

Deprecated.

Sets the value of the attribute: contextProperties.

Supported API: false

Specified by:

setContextProperties in interface ContextHolder

Parameters:

a_ContextProperties -

getResponseExceptions

public Vector getResponseExceptions()

Deprecated.

Gets the value of the attribute: responseExceptions.

Supported API: false

Specified by:

getResponseExceptions in interface ContextHolder

Returns:

Vector

setResponseExceptions

public void setResponseExceptions(Vector a_ResponseExceptions)

Deprecated.

Sets the value of the attribute: responseExceptions.

Supported API: false

Specified by:

setResponseExceptions in interface ContextHolder

Parameters:

a_ResponseExceptions -

getResponseFooters

public Vector getResponseFooters()

Deprecated.

Gets the value of the attribute: responseFooters.

Supported API: false

Specified by:

getResponseFooters in interface ContextHolder

Returns:

Vector

setResponseFooters

public void setResponseFooters(Vector a_ResponseFooters)

Deprecated.

Sets the value of the attribute: responseFooters.

Supported API: false

Specified by:

setResponseFooters in interface ContextHolder

Parameters:

a_ResponseFooters -

getResponseHeaders

public Vector getResponseHeaders()

Deprecated.

Gets the value of the attribute: responseHeaders.

Supported API: false

Specified by:

getResponseHeaders in interface ContextHolder

Returns:

Vector

setResponseHeaders

public void setResponseHeaders(Vector a_ResponseHeaders)

Deprecated.

Sets the value of the attribute: responseHeaders.

Supported API: false

Specified by:

setResponseHeaders in interface ContextHolder

Parameters:

a_ResponseHeaders -

getResponseMessages

public Vector getResponseMessages()

Deprecated.

Gets the value of the attribute: responseMessages.

Supported API: false

Specified by:

getResponseMessages in interface ContextHolder

Returns:

Vector

setResponseMessages

public void setResponseMessages(Vector a_ResponseMessages)

Deprecated.

Sets the value of the attribute: responseMessages.

Supported API: false

Specified by:

setResponseMessages in interface ContextHolder

Parameters:

a_ResponseMessages -

getResponseString

public String getResponseString()

Deprecated.

Gets the value of the attribute: responseString.

Supported API: false

Specified by:

getResponseString in interface ContextHolder

Returns:

String

setResponseString

public void setResponseString(String a_ResponseString)

Deprecated.

Sets the value of the attribute: responseString.

Supported API: false

Specified by:

setResponseString in interface ContextHolder

Parameters:

a_ResponseString -

getStatus

public int getStatus()

Deprecated.

Gets the value of the attribute: status.

Supported API: false

Specified by:

getStatus in interface ContextHolder

Returns:

int

setStatus

public void setStatus(int a_Status)

Deprecated.

Sets the value of the attribute: status.

Supported API: false

Specified by:

setStatus in interface ContextHolder

Parameters:

a_Status -

getFormData

public Properties getFormData()

Deprecated.

Gets the value of the attribute: formData.

Supported API: false

Specified by:

getFormData in interface ContextHolder

Returns:

Properties

setFormData

public void setFormData(Properties a_FormData)

Deprecated.

Sets the value of the attribute: formData.

Supported API: false

Specified by:

setFormData in interface ContextHolder

Parameters:

a_FormData -

getQueryData

public Properties getQueryData()

Deprecated.

Gets the value of the attribute: queryData.

Supported API: false

Specified by:

getQueryData in interface ContextHolder

Returns:

Properties

setQueryData

public void setQueryData(Properties a_QueryData)

Deprecated.

Sets the value of the attribute: queryData.

Supported API: false

Specified by:

setQueryData in interface ContextHolder

Parameters:

a_QueryData -

addToResponseExceptions

public void addToResponseExceptions(Exception newException)

Deprecated.

Adds a LocalizableMessage message to the list of stackTraces that can be presented with the Windchill Script call

showResponseExceptions

Supported API: false

Specified by:

addToResponseExceptions in interface ContextHolder

Parameters:

newException -

addToResponseMessages

public void addToResponseMessages(LocalizableMessage newMessage)

Deprecated.

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseMessages

Supported API: false

Specified by:

addToResponseMessages in interface ContextHolder

Parameters:

newMessage -

addToResponseHeaders

public void addToResponseHeaders(LocalizableMessage newHeader)

Deprecated.

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseHeaders

Supported API: false

Specified by:

addToResponseHeaders in interface ContextHolder

Parameters:

newHeader -

addToResponseFooters

public void addToResponseFooters(LocalizableMessage newFooter)

Deprecated.

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseFooters

Supported API: false

Specified by:

addToResponseFooters in interface ContextHolder

Parameters:

newFooter -

getPrintWriter

private PrintWriter getPrintWriter(OutputStream out,
                                   Locale locale)

getState

public HTTPState getState()

Gets the object for the association that plays role: theState.

Supported API: false

Specified by:

getState in interface ProcessorService

Returns:

HTTPState

setState

public void setState(HTTPState a_State)

Sets the object for the association that plays role: theState.

Supported API: false

Specified by:

setState in interface ProcessorService

Parameters:

a_State -

getJSSrc

public void getJSSrc(Properties parameters,
                     Locale locale,
                     OutputStream os)

getIcon

public void getIcon(Properties parameters,
                    Locale locale,
                    OutputStream os)
             throws IOException

Throws:

IOException

getObjStateHelperJSSrc

public void getObjStateHelperJSSrc(Properties parameters,
                                   Locale locale,
                                   OutputStream os)

getCodebaseURLIntoJSSrc

public void getCodebaseURLIntoJSSrc(Properties parameters,
                                    Locale locale,
                                    OutputStream os)

getUserAgentIntoJSSrc

public void getUserAgentIntoJSSrc(Properties parameters,
                                  Locale locale,
                                  OutputStream os)

genTrailSyncForm

public void genTrailSyncForm(Properties parameters,
                             Locale locale,
                             OutputStream os)

getDeleteLocalCacheNames

public void getDeleteLocalCacheNames(Properties parameters,
                                     Locale locale,
                                     OutputStream os)

getContainerReferenceString

public void getContainerReferenceString(Properties parameters,
                                        Locale locale,
                                        OutputStream os)
                                 throws WTException

Get the container reference string (i.e. oid in the string format) for the current context container

Throws:

WTException

getSerializedSolutionType

public void getSerializedSolutionType(Properties parameters,
                                      Locale locale,
                                      OutputStream os)

getCreateDialogWindowJS

public void getCreateDialogWindowJS(Properties parameters,
                                    Locale locale,
                                    OutputStream os)

getTitleWithIdentity

public void getTitleWithIdentity(Properties parameters,
                                 Locale locale,
                                 OutputStream os)

getOrgContextValue

private String getOrgContextValue(String key)

printOrganizationFields

public void printOrganizationFields(Properties parameters,
                                    Locale locale,
                                    OutputStream os)

getSelectedOrWsContainer

private WTContainer getSelectedOrWsContainer(HTTPState state,
                                             EPMWorkspace ws)

Get selected container as selected in the pull-down (in case it has been changed). If nothing found (which is not likely), get context workspace's container

Parameters:

state -

ws - Context workspace

Returns:

isAutoNumberingEnabled

public void isAutoNumberingEnabled(Properties parameters,
                                   Locale locale,
                                   OutputStream os)

getOrgDisplayFlag

public void getOrgDisplayFlag(Properties parameters,
                              Locale locale,
                              OutputStream os)

listOrganizationIDs

public void listOrganizationIDs(Properties parameters,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Throws:

WTException

getProeDateCode

public String getProeDateCode()

printProeWC7Support

public void printProeWC7Support(Properties parameters,
                                Locale locale,
                                OutputStream os)

doesProeSupportWC7

public boolean doesProeSupportWC7()

getIsProjectLinkContext

public void getIsProjectLinkContext(Properties parameters,
                                    Locale locale,
                                    OutputStream os)
                             throws WTException

Throws:

WTException

getIsPDMLinkContext

public void getIsPDMLinkContext(Properties parameters,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Throws:

WTException

getIsProIContext

public void getIsProIContext(Properties parameters,
                             Locale locale,
                             OutputStream os)
                      throws WTException

Throws:

WTException

printProEDateCode

public void printProEDateCode(Properties parameters,
                              Locale locale,
                              OutputStream os)

isContainerChanged

private boolean isContainerChanged()

returns true if container has been changed in the container pull-down.