com.ptc.windchill.enterprise.change2.tags
Class RoleParticipantConfigTag

java.lang.Object
  SimpleTagSupport
      com.ptc.windchill.enterprise.change2.tags.RoleParticipantConfigTag

public class RoleParticipantConfigTag
extends SimpleTagSupport

RoleParticipantConfigTag sets attributes of the roleParticipantConfig tag. The only required attribute is role. The participantFullName and participantUFID are optional.

Tag parameter	Description	Object Type
role	Specify the name of the role ASSIGNEE or REVIEWER	java.lang.String
participantFullName	Returns the Role Paticipant Full Name	java.lang.String
participantUFID	Returns the Role Paticipant ufid	java.lang.String

Supported API: true

Extendable: false

Method Summary

void	doTag() This is the required method to process the tag in the JSP page.
String	getParticipantFullName() Method to get the attribute representing the participant full name.
String	getParticipantUFID() Method to get the participant ufid attribute name.
String	getRole() Method to get the role value Supported API: true
protected Enumeration<WTPrincipalReference>	getRoleParticipants(wt.team.TeamManaged tm) This method gets the participants in a role for the specified TeamManaged object.
protected wt.team.TeamManaged	getTeamManagedObject() This method gets a TeamManaged object and returns it.
void	setParticipantFullName(String s) Method to set the attribute name representing the participant full name.
void	setParticipantUFID(String s) Method to set the participant ufid attribute name Supported API: true
void	setRole(String role) Method to set the role name Supported API: true

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setRole

public void setRole(String role)

Method to set the role name

Supported API: true

Parameters:

role - The role name of the participant

getRole

public String getRole()

Method to get the role value

Supported API: true

Returns:

The String value of the role

getParticipantFullName

public String getParticipantFullName()

Method to get the attribute representing the participant full name.

Supported API: true

Returns:

The String value of the participant full name

setParticipantFullName

public void setParticipantFullName(String s)

Method to set the attribute name representing the participant full name.

Supported API: true

Parameters:

s - The full name of the participant as a String

getParticipantUFID

public String getParticipantUFID()

Method to get the participant ufid attribute name.

Supported API: true

Returns:

The String value of the participant UFID

setParticipantUFID

public void setParticipantUFID(String s)

Method to set the participant ufid attribute name

Supported API: true

Parameters:

s - The UFID of the participant

getTeamManagedObject

protected wt.team.TeamManaged getTeamManagedObject()
                                            throws WTException

This method gets a TeamManaged object and returns it.

Supported API: true

Returns:

The TeamManged object from the command bean

Throws:

A - WTException exception is thrown if processing of returning the TeamManaged object fails

WTException

getRoleParticipants

protected Enumeration<WTPrincipalReference> getRoleParticipants(wt.team.TeamManaged tm)
                                                         throws WTException

This method gets the participants in a role for the specified TeamManaged object.

Supported API: true

Returns:

Multiple role participants may exist so role participants are returned as a Enumeration.

Throws:

A - WTException exception is thrown if processing of getting the team or principal targets fails

WTException

doTag

public void doTag()
           throws JspException

This is the required method to process the tag in the JSP page. If the page does not contain an instantiated com.ptc.netmarkets.util.beans.NmCommandBean object no JSP page attributes will be modified.

Supported API: true

Throws:

JspException - If an exception is raised during processing it will be wrapped into a JspException.