atg.epub.pws.taglib
Class GetWorkflowDefinitionsTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      atg.web.tagsupport.PageVariableTagSupport
          atg.web.tagsupport.CountTagSupport
              atg.epub.pws.taglib.GetWorkflowDefinitionsTag

All Implemented Interfaces:

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

public class GetWorkflowDefinitionsTag
extends atg.web.tagsupport.CountTagSupport

Tag for obtaining a list of workflow definitions from the workflow manager.

See Also:

WorkflowDescriptor, atg.epub.pws.taglib.GetWorkflowDefinitions$Results, Serialized Form

Nested Class Summary

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

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.web.tagsupport.CountTagSupport

mCount, mIndex, mTotalCountVar

Fields inherited from class atg.web.tagsupport.PageVariableTagSupport

sResourceBundle

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

GetWorkflowDefinitionsTag()
Empty constructor

Method Summary

int	doStartTag() Finds all the workflow descriptors in the system.
protected boolean	filterWorkflow(java.lang.String pWorkflowName)
boolean	getUserOnly()
void	release()
void	setUserOnly(boolean pUserOnly) Sets userOnly flag which will cause the workflows which are returned to include only those which the calling user can start

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

GetWorkflowDefinitionsTag

public GetWorkflowDefinitionsTag()

Empty constructor

Method Detail

setUserOnly

public void setUserOnly(boolean pUserOnly)

Sets userOnly flag which will cause the workflows which are returned to include only those which the calling user can start

Parameters:

pUserOnly - false to return all workflow definitions, true to return only those which the current user can start

getUserOnly

public boolean getUserOnly()

Returns:

the userOnly flag, false to return all workflow definitions, true to return only those which the current user can start

doStartTag

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

Finds all the workflow descriptors in the system. If the userOnly flag is true, then it returns only those workflow descriptors which the user can start.

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 descriptor cannot be found

See Also:

WorkflowDescriptor, atg.epub.pws.taglib.GetWorkflowDefinitions$Results

filterWorkflow

protected boolean filterWorkflow(java.lang.String pWorkflowName)

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