atg.epub.pws.taglib
Class GetUnsuppliedAssetsTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by atg.web.tagsupport.PageVariableTagSupport
          extended by atg.web.tagsupport.CountTagSupport
              extended by atg.epub.pws.taglib.PWSResourceFileTagSupport
                  extended by atg.epub.pws.taglib.GetUnsuppliedAssetsTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

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

Tag for obtaining the names and counts of all and required asset placeholders in the workflow for the given project.

See Also:
GetUnsuppliedAssetsTag.Results, Serialized Form

Nested Class Summary
 class GetUnsuppliedAssetsTag.Results
          Results class for returning output from this tag.
static class GetUnsuppliedAssetsTag.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 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
GetUnsuppliedAssetsTag()
          Empty Constructor
 
Method Summary
 int doStartTag()
          Sets the output id/var variable to a Results object which contains the names and counts of all and required unsupplied asset variables.
 java.lang.String getProcessId()
           
 void release()
           
 void setProcessId(java.lang.String pProcessId)
          Sets the process id to return the unsupplied assets for
 
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

GetUnsuppliedAssetsTag

public GetUnsuppliedAssetsTag()
Empty Constructor

Method Detail

setProcessId

public void setProcessId(java.lang.String pProcessId)
Sets the process id to return the unsupplied assets for

Parameters:
pProcessId - a valid process id

getProcessId

public java.lang.String getProcessId()
Returns:
the process id which to return the unsupplied assets for

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Sets the output id/var variable to a Results object which contains the names and counts of all and required unsupplied asset variables.

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 the process id is invalid or the process is not initialized properly
See Also:
GetUnsuppliedAssetsTag.Results

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