atg.epub.pws.taglib

Class GetProjectsTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

atg.web.tagsupport.PageVariableTagSupport

atg.web.tagsupport.CountTagSupport

atg.epub.pws.taglib.GetProjectsTag

All Implemented Interfaces:

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

public class GetProjectsTag
extends atg.web.tagsupport.CountTagSupport

Tag for returning all the projects with the given status.

See Also:

Project, GetProjectsTag.Results, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GetProjectsTag.Results Results class for returning output for the GetProjectsTag.
static class	GetProjectsTag.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 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

Constructors

Constructor and Description
GetProjectsTag() Empty Constructor

Method Summary

Modifier and Type	Method and Description
int	doStartTag() Returns a Results object which contains all the projects with the given status.
java.lang.Object	getProjectIds()
java.lang.String	getSortProperties()
java.lang.String	getStatus()
void	release()
void	setProjectIds(java.lang.Object pProjectIds) Sets the project ids to return the projects for
void	setSortProperties(java.lang.String pSortProperties) Sets a comma separated list of Project properties to sort the return collection by
void	setStatus(java.lang.String pStatus) Sets the status of the projects to query for

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

GetProjectsTag

public GetProjectsTag()

Empty Constructor

Method Detail

setStatus

public void setStatus(java.lang.String pStatus)

Sets the status of the projects to query for

Parameters:

pStatus - the status String, "Active" or "Completed"

See Also:

ProjectEnumStatus

getStatus

public java.lang.String getStatus()

Returns:

the status to query for

setSortProperties

public void setSortProperties(java.lang.String pSortProperties)

Sets a comma separated list of Project properties to sort the return collection by

Parameters:

pSortProperties - a comma separated list of Project properties

getSortProperties

public java.lang.String getSortProperties()

Returns:

a comma separated list of Project properties used to sort the return set by

setProjectIds

public void setProjectIds(java.lang.Object pProjectIds)

Sets the project ids to return the projects for

Parameters:

pProjectIds - a valid collection or array of project ids

getProjectIds

public java.lang.Object getProjectIds()

Returns:

the project ids which to return the projects for

doStartTag

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

Returns a Results object which contains all the projects with the given status.

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 an error occurs while querying

See Also:

Project, GetProjectsTag.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()