Package wt.workflow.work
Class WorkProcessorService
java.lang.Object
wt.workflow.work.WorkProcessorService
- All Implemented Interfaces:
Externalizable,Serializable,ContextHolder,ProcessorService
When executed from a class that extends BasicTemplateProcessor, these
script call can be invoked by using the 'useProcessorService service
= ' html template entry.
Supported API: true
Extendable: false
-
Field Summary
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, STATUSFields inherited from interface wt.templateutil.processor.ProcessorService
STATE -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the attribute: contextAction; Context Action is the name of the action of the current page
Supported API: trueGets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page
Supported API: trueGets the value of the attribute: contextObj; Context Object is the reference object of the current page
Supported API: trueGets the value of the attribute: contextProperties.Gets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.Gets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.Gets the value of the attribute: responseExceptions.Gets the value of the attribute: responseFooters.Gets the value of the attribute: responseHeaders.Gets the value of the attribute: responseMessages.Gets the value of the attribute: responseString.getState()Gets the object for the association that plays role: theState.intGets the value of the attribute: status.voidprojectLinkAttributes(Properties parameters, Locale locale, OutputStream os) If the context object was created in a ProjectLink context (i.e.voidsetContextAction(String a_ContextAction) Sets the value of the attribute: contextAction; Context Action is the name of the action of the current page
Supported API: truevoidsetContextClassName(String a_ContextClassName) Sets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page
Supported API: truevoidsetContextObj(Object a_ContextObj) Sets the value of the attribute: contextObj; Context Object is the reference object of the current page
Supported API: truevoidsetContextProperties(Properties a_ContextProperties) Sets the value of the attribute: contextProperties.voidsetFormData(Properties a_FormData) Sets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.voidsetQueryData(Properties a_QueryData) Sets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.voidsetResponseExceptions(Vector a_ResponseExceptions) Sets the value of the attribute: responseExceptions.voidsetResponseFooters(Vector a_ResponseFooters) Sets the value of the attribute: responseFooters.voidsetResponseHeaders(Vector a_ResponseHeaders) Sets the value of the attribute: responseHeaders.voidsetResponseMessages(Vector a_ResponseMessages) Sets the value of the attribute: responseMessages.voidsetResponseString(String a_ResponseString) Sets the value of the attribute: responseString.voidSets the object for the association that plays role: theState.voidsetStatus(int a_Status) Sets the value of the attribute: status.
-
Method Details
-
projectLinkAttributes
If the context object was created in a ProjectLink context (i.e. has a projectContainer) print attributes of the parent project: Project Name Project hosting organization Project manager Project description
Supported API: true- Parameters:
parameters- the arguments that were passed to the Windchill script calllocale- the Locale to send to the invoked methods for localizationos- the output stream
-
getState
Gets the object for the association that plays role: theState.
Supported API: true- Specified by:
getStatein interfaceProcessorService- Returns:
- HTTPState
-
setState
Sets the object for the association that plays role: theState.
Supported API: true- Specified by:
setStatein interfaceProcessorService- Parameters:
a_State-
-
getContextAction
Gets the value of the attribute: contextAction; Context Action is the name of the action of the current page
Supported API: true- Specified by:
getContextActionin interfaceContextHolder- Returns:
- String
-
setContextAction
Sets the value of the attribute: contextAction; Context Action is the name of the action of the current page
Supported API: true- Specified by:
setContextActionin interfaceContextHolder- Parameters:
a_ContextAction-
-
getContextObj
Gets the value of the attribute: contextObj; Context Object is the reference object of the current page
Supported API: true- Specified by:
getContextObjin interfaceContextHolder- Returns:
- Object
-
setContextObj
Sets the value of the attribute: contextObj; Context Object is the reference object of the current page
Supported API: true- Specified by:
setContextObjin interfaceContextHolder- Parameters:
a_ContextObj-
-
getContextClassName
Gets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page
Supported API: true- Specified by:
getContextClassNamein interfaceContextHolder- Returns:
- String
-
setContextClassName
Sets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page
Supported API: true- Specified by:
setContextClassNamein interfaceContextHolder- Parameters:
a_ContextClassName-
-
getContextProperties
Gets the value of the attribute: contextProperties.
Supported API: true- Specified by:
getContextPropertiesin interfaceContextHolder- Returns:
- Properties
-
setContextProperties
Sets the value of the attribute: contextProperties.
Supported API: true- Specified by:
setContextPropertiesin interfaceContextHolder- Parameters:
a_ContextProperties-
-
getResponseExceptions
Gets the value of the attribute: responseExceptions.
Supported API: true- Specified by:
getResponseExceptionsin interfaceContextHolder- Returns:
- Vector
-
setResponseExceptions
Sets the value of the attribute: responseExceptions.
Supported API: true- Specified by:
setResponseExceptionsin interfaceContextHolder- Parameters:
a_ResponseExceptions-
-
getResponseHeaders
Gets the value of the attribute: responseHeaders.
Supported API: true- Specified by:
getResponseHeadersin interfaceContextHolder- Returns:
- Vector
-
setResponseHeaders
Sets the value of the attribute: responseHeaders.
Supported API: true- Specified by:
setResponseHeadersin interfaceContextHolder- Parameters:
a_ResponseHeaders-
-
getResponseMessages
Gets the value of the attribute: responseMessages.
Supported API: true- Specified by:
getResponseMessagesin interfaceContextHolder- Returns:
- Vector
-
setResponseMessages
Sets the value of the attribute: responseMessages.
Supported API: true- Specified by:
setResponseMessagesin interfaceContextHolder- Parameters:
a_ResponseMessages-
-
getResponseString
Gets the value of the attribute: responseString.
Supported API: true- Specified by:
getResponseStringin interfaceContextHolder- Returns:
- String
-
setResponseString
Sets the value of the attribute: responseString.
Supported API: true- Specified by:
setResponseStringin interfaceContextHolder- Parameters:
a_ResponseString-
-
getStatus
public int getStatus()Gets the value of the attribute: status.
Supported API: true- Specified by:
getStatusin interfaceContextHolder- Returns:
- int
-
setStatus
public void setStatus(int a_Status) Sets the value of the attribute: status.
Supported API: true- Specified by:
setStatusin interfaceContextHolder- Parameters:
a_Status-
-
getFormData
Gets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.
Supported API: true- Specified by:
getFormDatain interfaceContextHolder- Returns:
- Properties
-
setFormData
Sets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.
Supported API: true- Specified by:
setFormDatain interfaceContextHolder- Parameters:
a_FormData-
-
getQueryData
Gets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.
Supported API: true- Specified by:
getQueryDatain interfaceContextHolder- Returns:
- Properties
-
setQueryData
Sets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.
Supported API: true- Specified by:
setQueryDatain interfaceContextHolder- Parameters:
a_QueryData-
-