atg.epub.pws.taglib
Class GetAssignableUsersTag

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

All Implemented Interfaces:

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

public class GetAssignableUsersTag
extends atg.web.tagsupport.PageVariableTagSupport

Tag for returning a set of users that can be assigned to a workflow task. This tag returns a collection of User objects.

See Also:

User, Serialized Form

Nested Class Summary

static class	GetAssignableUsersTag.TEI TagExtraInfo class to handle var/id processing.
class	GetAssignableUsersTag.UserFirstLastComparator

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

GetAssignableUsersTag()
Empty Constructor

Method Summary

int	doStartTag() This tag returns the set of User objects which contains the users which can be assigned to the task of the given workflow descriptor.
boolean	getIncludeAccUsers()
TaskDescriptor	getTaskDescriptor()
void	release()
void	setIncludeAccUsers(boolean pIncludeAccUsers) Sets the includeAccUsers flag to indicate whether or not to include the ACC users in the assignable users
void	setTaskDescriptor(TaskDescriptor pTaskDescriptor) Sets the task descriptor of the task which the user list will be created.

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

GetAssignableUsersTag

public GetAssignableUsersTag()

Empty Constructor

Method Detail

setTaskDescriptor

public void setTaskDescriptor(TaskDescriptor pTaskDescriptor)

Sets the task descriptor of the task which the user list will be created.

Parameters:

pTaskDescriptor - the task descriptor of the task which the user list will be created

getTaskDescriptor

public TaskDescriptor getTaskDescriptor()

Returns:

the task descriptor of the task that the user list will be created for

setIncludeAccUsers

public void setIncludeAccUsers(boolean pIncludeAccUsers)

Sets the includeAccUsers flag to indicate whether or not to include the ACC users in the assignable users

Parameters:

pIncludeAccUsers - flag whether or not to include ACC users

getIncludeAccUsers

public boolean getIncludeAccUsers()

Returns:

true if the assignable users should include the acc users, false if not

doStartTag

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

This tag returns the set of User objects which contains the users which can be assigned to the task of the given workflow descriptor.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

See Also:

User

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class atg.web.tagsupport.PageVariableTagSupport

See Also:

Tag.release()