atg.epub.pws.taglib
Class GetProjectsTag

java.lang.Object
  CountTagSupport
      atg.epub.pws.taglib.GetProjectsTag

public class GetProjectsTag
extends CountTagSupport

Tag for returning all the projects with the given status.

See Also:

Project, GetProjectsTag$Results

Nested Class Summary

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

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

GetProjectsTag()
Empty Constructor

Method Summary

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

Throws:

javax.servlet.jsp.JspException - if an error occurs while querying

See Also:

Project, GetProjectsTag$Results

release

public void release()

See Also:

Tag.release()