atg.epub.pws.taglib

Class GetWorkflowDescriptorTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

atg.web.tagsupport.PageVariableTagSupport

atg.web.tagsupport.CountTagSupport

atg.epub.pws.taglib.PWSResourceFileTagSupport

atg.epub.pws.taglib.GetWorkflowDescriptorTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class GetWorkflowDescriptorTag
extends atg.epub.pws.taglib.PWSResourceFileTagSupport

Tag for obtaining a workflow descriptor object for a given workflow. This tag requires that a processId and id/var be supplied. The values will be set in Results.processWorkflow and Results.projectWorkflow. Optionally, if workflowId is supplied, it will return the workflow descriptor only for that workflow and will set the value is Results.workflowDescriptor.

See Also:

WorkflowDescriptor, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GetWorkflowDescriptorTag.Results Results class for returning output for the GetWorkflowDescriptorTag.
static class	GetWorkflowDescriptorTag.TEI TagExtraInfo class to handle var/id processing.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.web.tagsupport.CountTagSupport

mCount, mIndex, mTotalCountVar

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
GetWorkflowDescriptorTag() Empty constructor

Method Summary

Modifier and Type	Method and Description
int	doStartTag() Finds the process's workflow descriptor and sets it into the variable supplied in id/var.
java.lang.String	getProcessId()
java.lang.String	getWorkflowId()
void	release()
void	setProcessId(java.lang.String pProcessId) Sets the process id to return the workflow descriptor for
void	setWorkflowId(java.lang.String string) Sets the workflow ID to get

Methods inherited from class atg.epub.pws.taglib.PWSResourceFileTagSupport

getResource, getResource

Methods inherited from class atg.web.tagsupport.CountTagSupport

getCount, getCountAsInt, getIndex, getIndexAsInt, getTotalCountVar, setCount, setIndex, setTotalCount, setTotalCount, setTotalCountVar

Methods inherited from class atg.web.tagsupport.PageVariableTagSupport

getDynamoRequest, getId, getVar, isBlank, setId, setPageVariable, setScope, setVar

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

GetWorkflowDescriptorTag

public GetWorkflowDescriptorTag()

Empty constructor

Method Detail

setProcessId

public void setProcessId(java.lang.String pProcessId)

Sets the process id to return the workflow descriptor for

Parameters:

pProcessId - a valid process id

getProcessId

public java.lang.String getProcessId()

Returns:

the process id which to return the workflow descriptor for

setWorkflowId

public void setWorkflowId(java.lang.String string)

Sets the workflow ID to get

Parameters:

string - the workflow Id

getWorkflowId

public java.lang.String getWorkflowId()

Returns:

the workflow Id to get

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Finds the process's workflow descriptor and sets it into the variable supplied in id/var.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - if a workflow instance could not be found or the given process id is invalid

See Also:

WorkflowDescriptor

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class atg.web.tagsupport.CountTagSupport

See Also:

Tag.release()