atg.epub.pws.taglib
Class GetWorkflowDescriptorTag

java.lang.Object
  PWSResourceFileTagSupport
      atg.epub.pws.taglib.GetWorkflowDescriptorTag

public class GetWorkflowDescriptorTag
extends 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

Nested Class Summary

class	GetWorkflowDescriptorTag.Results Results class for returning output for the GetWorkflowDescriptorTag.
static class	GetWorkflowDescriptorTag.TEI TagExtraInfo class to handle var/id processing.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

GetWorkflowDescriptorTag()
Empty constructor

Method Summary

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 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.

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()

See Also:

Tag.release()