StaticWfHelper

Object
- StaticWfHelper

All Implemented Interfaces:

RemoteAccess
```
public class StaticWfHelper
extends Object
implements RemoteAccess
```
purpose: provide static methods to ease various common windchill tasks in the workflow area

Author:

mkraegeloh

Field Summary

Fields
Modifier and Type Field and Description

static int MAJOR

static int MINOR
- Fields inherited from interface RemoteAccess
  versionID

Fields
Modifier and Type	Field and Description
`static int`	`MAJOR`
`static int`	`MINOR`

Constructor Summary

Constructors
Constructor and Description

StaticWfHelper()

Constructors
Constructor and Description
`StaticWfHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addPrincipalsToContainerRoles(List<String> containerOIDs, List<String> roleNames, List<String> principals, boolean cleanCache)`
`static void`	`addPrincipalsToContainerRoles(WTContainer container, List<String> roleNames, List<String> principals, boolean cleanCache)`
`static void`	`addPrincipalsToRole(WTContainer wtc, ContainerTeam team, Role role, List<String> principals, boolean cleanCache)`
`static void`	`addPrincipalToRole(String nameOfContainer, String nameOfRole, String nameOfWTPrincipal, boolean cleanCache)`
`static void`	`addPrincipalToRole(WTContainer wtc, ContainerTeam team, Role role, WTPrincipal principal, boolean cleanCache)`
`static void`	`addPrincipalToRole(WTContainer container, String nameOfRole, WTPrincipal principal, boolean cleanCache)`
`static Persistable`	`addToChangeActivity(Class linkClass, Changeable2 changeable, WTChangeActivity2 ca)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static AffectedActivityData`	`addToChangeActivityAffected(Changeable2 changeable, WTChangeActivity2 ca)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static ChangeRecord2`	`addToChangeActivityResulting(Changeable2 changeable, WTChangeActivity2 ca)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static WTChangeOrder2`	`addToChangeOrder(Object changeable, Map meta)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static void`	`addUserToRole(Object to, Role r, String user)` add a user to a role in a team
`static void`	`addUserToRole(Object to, Role r, WTUser user)` add a user to a role in a team
`static void`	`addUserToRole(Object to, String role, String user)` add a user to a role in a team
`static WTChangeActivity2`	`createChangeActivity(Changeable2 changeable, WTChangeOrder2 co, Map meta)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static WTChangeOrder2`	`createChangeOrder(Object changeable, Map meta)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static WTChangeOrder2`	`createChangeOrder2(Object changeable, Map meta)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static void`	`delegate(WorkItem w, WTUser u, String c)` delegate a workitem to another principal
`static WTChangeActivity2`	`getLatestChangeActivityForChangeable(Changeable2 changeable)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static WTUser`	`getLdapUserByName(String name)`
`static WfProcess`	`getParentProcess(WfActivity wfa)` returns the parent process for a WfActivity
`static Object`	`getParentProcess(WorkItem wi)` return parent process of workitem (NOTE: switches off access control to get the WfProcess)
`static Object`	`getParentProcessVar(WorkItem wi, String varName)` TODO javadoc
`static Object`	`getProcessDataVar(Object wfe, String varName)` get variable from the ProcessData of a workflow execution object (e˙g˙, WorkItem, WfProcess) - NOTE: switches off access control to avoid access control problems!
`static WTUser`	`getUserByName(String name)`
`static WTUser`	`getUserByName(String name, boolean ignoreCase)`
`static WTPrincipal`	`getWTPrincipalByName(String name, boolean ignoreCase)`
`static List<WTGroup>`	`groupList(String username, String groupname)` returns the list of groups of a given name where user is a member can be used to determine for example in which products user is a productmanager
`static Boolean`	`isAssignmentCompleted(WfAssignedActivity wfa)` tells if the WfAssignedActivity is complete
`static boolean`	`isUserInGroup(String u, String g)` tell if user is a member of given group
`static boolean`	`isUserInGroup(String u, WTGroup g)` tell if user is a member of given group
`static boolean`	`isUserInRole(String u, String role, ContainerTeam t)` tell if user is in given role of given team
`static boolean`	`isUserInRole(String u, String role, ContainerTeamReference tr)` tell if user is in given role of given team
`static boolean`	`isUserInRole(String u, String role, LifeCycleManaged l)` tell if user is in given role of the team the LifeCycleManaged object belongs to
`static boolean`	`isUserInRole(String u, String role, Team t)` tell if user is in given role of given team
`static boolean`	`isUserInRole(String u, String role, WfProcess p)` tell if user is in given role of the wfprocess' team
`static boolean`	`isUserInRoles(String u, String[] roles, boolean ignoreCase, ContainerTeamReference tr)` TODO javadoc
`static boolean`	`isUserInRoles2(String u, String[] roles, boolean ignoreCase, ContainerTeamReference tr)`
`static <T> boolean`	`isUserMemberOfRoles(ContainerTeam containerTeam, Class<T> dummy, String[] roles, String userName)`
`static <T> boolean`	`isUserMemberOfRoles2(ContainerTeam containerTeam, Class<T> dummy, String[] roles, String userName)`
`static void`	`loadChangesFromFile(String[] a)` Deprecated. moved to ext.sulis.change.ChangeHelper
`static void`	`main(String[] a)` expose some functionality to command line, call without argument for help.
`static List<WTGroup>`	`memberGroups(WTGroup g)` return a List of nested group members (only the members that are themselves a WTGroup)
`static Vector`	`members(WTGroup g, List<Persistable> alreadyChecked)` return a Vector with the group members - nested groups are resolved.
`static Vector`	`members2(WTGroup g, List<Persistable> alreadyChecked)`
`static <T> List<T>`	`membersOfRole(ContainerTeam team, Role role, boolean resolveRecursive, Class<T> dummy)`
`static List<WTGroup>`	`parentGroups(WTPrincipal p)` return the groups the principal is in
`static List<WTPrincipal>`	`principalsInGroup(WTGroup g)` get a map with user name/fullname\|WTUser pairs of users in group - resolves groups in groups to users
`static void`	`removeAllFromContainerRoles(List<String> containerOIDs, List<String> roleNames, boolean cleanCache)`
`static void`	`removeAllFromContainerRoles(WTContainer container, List<String> roleNames, boolean cleanCache)`
`static void`	`removeAllFromRole(ContainerTeam team, Role role, boolean cleanCache)`
`static void`	`removePrincipalFromRole(ContainerTeam team, Role role, WTPrincipal principal, boolean cleanCache)`
`static void`	`removePrincipalFromRole(String nameOfContainer, String nameOfRole, String nameOfWTPrincipal, boolean cleanCache)`
`static void`	`removePrincipalFromRole(WTContainer container, String nameOfRole, WTPrincipal principal, boolean cleanCache)`
`static void`	`removePrincipalsFromContainerRoles(List<String> containerOIDs, List<String> roleNames, List<String> principals, boolean cleanCache)`
`static void`	`removePrincipalsFromContainerRoles(WTContainer container, List<String> roleNames, List<String> principals, boolean cleanCache)`
`static void`	`removePrincipalsFromRole(ContainerTeam team, Role role, List<String> principals, boolean cleanCache)`
`static List<List<Object>>`	`reportContainerRoleMembers(List<String> containerOIDs, List<String> roleNames)`
`static List<List<Object>>`	`reportContainerRoleMembers(WTContainer container, List<String> roleNames)`
`static void`	`setProcessDataVar(Object wfe, String varName, Object val)` set variable in the ProcessData of a workflow exection object (e˙g˙, WorkItem, WfProcess)
`static void`	`setProcessDataVars(Object wfe, Map<String,Object> vals)` set variable[s] in the ProcessData of a workflow execution object (e˙g˙, WorkItem, WfProcess) - NOTE: switches off access control to avoid access control problems!
`static HashMap<String,String>`	`usersInGroup(String groupName)` get a map with user name/fullname pairs of users in group with given name
`static HashMap<String,String>`	`usersInGroup(String g, boolean ignoreCase)` get a map with user name/fullname pairs of users in group with given name
`static <T> HashMap<String,T>`	`usersInGroup(String g, Class<T> dummy, boolean ignoreCase)` get a map with user name/fullname\|WTUser pairs of users in group with given name
`static HashMap<String,String>`	`usersInGroup(WTGroup g)` get a map with user name/fullname pairs of users in group - resolves groups in groups to users
`static <T> HashMap<String,T>`	`usersInGroup(WTGroup g, Class<T> dummy)` get a map with user name/fullname\|WTUser pairs of users in group - resolves groups in groups to users
`static <T> HashMap<String,T>`	`usersInGroup2(WTGroup g, Class<T> dummy)`
`static HashMap<String,String>`	`usersInRole(String role, ContainerTeam containerTeam)` get a map with user name/fullname pairs of users in given role of given team
`static HashMap<String,String>`	`usersInRole(String role, Team t)` get a map with user name/fullname pairs of users in given role of given team
`static HashMap<String,HashMap<String,String>>`	`usersInRoles(ContainerTeam t)` get a map with role/map user name/fullname roles of given container team
`static <T> HashMap<String,HashMap<String,T>>`	`usersInRoles(ContainerTeam t, Class<T> dummy)` get a map with role/map user name/fullname\|WTUser of roles of given containerteam
`static HashMap<String,HashMap<String,String>>`	`usersInRoles(Team t)` get a map with role/map user name/fullname roles of given team
`static <T> HashMap<String,HashMap<String,T>>`	`usersInRoles(Team t, Class<T> dummy)` get a map with role/map user name/fullname\|WTUser of roles of given team
`static HashMap<String,HashMap<String,String>>`	`usersInRoles2(ContainerTeam t)`
`static <T> HashMap<String,HashMap<String,T>>`	`usersInRoles2(ContainerTeam containerTeam, Class<T> dummy)`
`static HashMap<String,HashMap<String,String>>`	`usersInRoles2(Team t)`
`static <T> HashMap<String,HashMap<String,T>>`	`usersInRoles2(Team t, Class<T> dummy)`

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- MAJOR
```
public static final int MAJOR
```
  See Also:
  Constant Field Values
- MINOR
```
public static final int MINOR
```
  See Also:
  Constant Field Values

Constructor Detail
- StaticWfHelper
```
public StaticWfHelper()
```

Method Detail

main
```
public static void main(String[] a)
                 throws Exception
```
expose some functionality to command line, call without argument for help.

Parameters:
a - commandline arguments

Throws:

Exception

groupList
```
public static List<WTGroup> groupList(String username,
                      String groupname)
                               throws WTException
```
returns the list of groups of a given name where user is a member can be used to determine for example in which products user is a productmanager

Parameters:
username -
groupname -

Returns:
the list of WTUsers

Throws:

WTException

isUserInGroup
```
public static boolean isUserInGroup(String u,
                    WTGroup g)
                             throws WTException
```
tell if user is a member of given group

Parameters:
u - username
g - group to check

Returns:
true if user is member of group

Throws:

WTException

isUserInGroup
```
public static boolean isUserInGroup(String u,
                    String g)
                             throws WTException
```
tell if user is a member of given group

Parameters:
u - username
g - name of group to check

Returns:
true if user is member of group

Throws:

WTException

isUserInRole
```
public static boolean isUserInRole(String u,
                   String role,
                   ContainerTeamReference tr)
                            throws WTException
```
tell if user is in given role of given team

Parameters:
u - username
role - rolename
tr - ContainerTeamReference to ContainerTeam holding the roles

Returns:
true if user is in role

Throws:

WTException

isUserInRoles

public static boolean isUserInRoles(String u,
                    String[] roles,
                    boolean ignoreCase,
                    ContainerTeamReference tr)
                             throws WTException

TODO javadoc

Parameters:: u -; role -; tr -
Returns:
Throws:: WTException

isUserInRoles2

public static boolean isUserInRoles2(String u,
                     String[] roles,
                     boolean ignoreCase,
                     ContainerTeamReference tr)
                              throws WTRuntimeException,
                                     Exception

Throws:: WTRuntimeException; Exception

isUserInRole
```
public static boolean isUserInRole(String u,
                   String role,
                   ContainerTeam t)
                            throws WTException
```
tell if user is in given role of given team

Parameters:
u - username
role - rolename
t - ContainerTeam holding the roles

Returns:
true if user is in role

Throws:

WTException

isUserInRole
```
public static boolean isUserInRole(String u,
                   String role,
                   Team t)
                            throws WTException
```
tell if user is in given role of given team

Parameters:
u - username
role - rolename
t - Team holding the roles

Returns:
true if user is in role

Throws:

WTException

isUserInRole
```
public static boolean isUserInRole(String u,
                   String role,
                   LifeCycleManaged l)
                            throws WTException
```
tell if user is in given role of the team the LifeCycleManaged object belongs to

Parameters:
u - username
role - rolename
l - lifecyclemanaged object

Returns:
true if user is in role

Throws:

WTException

isUserInRole
```
public static boolean isUserInRole(String u,
                   String role,
                   WfProcess p)
                            throws WTException
```
tell if user is in given role of the wfprocess' team

Parameters:
u - username
role - rolename
p - worflow process

Returns:
true if user is in role

Throws:

WTException

usersInRole
```
public static HashMap<String,String> usersInRole(String role,
                                 ContainerTeam containerTeam)
                                          throws WTException
```
get a map with user name/fullname pairs of users in given role of given team

Parameters:
role - rolename
t - container team with roles

Returns:
map with user name/fullname pairs

Throws:

WTException

usersInRole
```
public static HashMap<String,String> usersInRole(String role,
                                 Team t)
                                          throws WTException
```
get a map with user name/fullname pairs of users in given role of given team

Parameters:
role - rolename
t - team with roles

Returns:
map with user name/fullname pairs

Throws:

WTException

usersInRoles
```
public static HashMap<String,HashMap<String,String>> usersInRoles(ContainerTeam t)
                                                           throws WTException
```
get a map with role/map user name/fullname roles of given container team

Parameters:
t - container team with roles

Returns:
map with role/map user name/fullname

Throws:

WTException

usersInRoles2

public static HashMap<String,HashMap<String,String>> usersInRoles2(ContainerTeam t)
                                                            throws Exception

Throws:: Exception

usersInRoles

public static <T> HashMap<String,HashMap<String,T>> usersInRoles(ContainerTeam t,
                                                 Class<T> dummy)
                                                      throws WTException

get a map with role/map user name/fullname|WTUser of roles of given containerteam

Parameters:: t - container team with roles
Returns:: map with role/map user name/fullname|WTUser
Throws:: WTException

usersInRoles2

public static <T> HashMap<String,HashMap<String,T>> usersInRoles2(ContainerTeam containerTeam,
                                                  Class<T> dummy)
                                                       throws Exception

Throws:: Exception

isUserMemberOfRoles

public static <T> boolean isUserMemberOfRoles(ContainerTeam containerTeam,
                              Class<T> dummy,
                              String[] roles,
                              String userName)
                                   throws Exception

Throws:: Exception

isUserMemberOfRoles2

public static <T> boolean isUserMemberOfRoles2(ContainerTeam containerTeam,
                               Class<T> dummy,
                               String[] roles,
                               String userName)
                                    throws Exception

Throws:: Exception

usersInRoles
```
public static HashMap<String,HashMap<String,String>> usersInRoles(Team t)
                                                           throws WTException
```
get a map with role/map user name/fullname roles of given team

Parameters:
t - container team with roles

Returns:
map with role/map user name/fullname

Throws:

WTException

usersInRoles2

public static HashMap<String,HashMap<String,String>> usersInRoles2(Team t)
                                                            throws Exception

Throws:: Exception

usersInRoles

public static <T> HashMap<String,HashMap<String,T>> usersInRoles(Team t,
                                                 Class<T> dummy)
                                                      throws WTException

get a map with role/map user name/fullname|WTUser of roles of given team

Parameters:: t - container team with roles
Returns:: map with role/map user name/fullname|WTUser
Throws:: WTException

usersInRoles2

public static <T> HashMap<String,HashMap<String,T>> usersInRoles2(Team t,
                                                  Class<T> dummy)
                                                       throws Exception

Throws:: Exception

addUserToRole
```
public static void addUserToRole(Object to,
                 String role,
                 String user)
                          throws WTException
```
add a user to a role in a team

Parameters:
to - team to add to - can be obid-string or teamreference or team
role - name of role to add user to
user - name of user to add

Throws:

WTException

addUserToRole
```
public static void addUserToRole(Object to,
                 Role r,
                 String user)
                          throws WTException
```
add a user to a role in a team

Parameters:
to - team to add to - can be obid-string or teamreference or team
r - role to add user to
user - name of user to add

Throws:

WTException

addUserToRole
```
public static void addUserToRole(Object to,
                 Role r,
                 WTUser user)
                          throws WTException
```
add a user to a role in a team

Parameters:
to - team to add to - can be obid-string or teamreference or team
r - role to add user to
user - WTUser to add

Throws:

WTException

usersInGroup
```
public static HashMap<String,String> usersInGroup(String groupName)
                                           throws WTException
```
get a map with user name/fullname pairs of users in group with given name

Parameters:
g - group name

Returns:
map with user name/fullname pairs

Throws:

thrown - if search with group name does not find exactly one group (case sensitive)

WTException

usersInGroup
```
public static HashMap<String,String> usersInGroup(String g,
                                  boolean ignoreCase)
                                           throws WTException
```
get a map with user name/fullname pairs of users in group with given name

Parameters:
g - group name
ignoreCase - true/false if search should be conducted case insensitive

Returns:
map with user name/fullname pairs

Throws:

thrown - if search with group name does not find exactly one goup

WTException

usersInGroup
```
public static <T> HashMap<String,T> usersInGroup(String g,
                                 Class<T> dummy,
                                 boolean ignoreCase)
                                      throws WTException
```
get a map with user name/fullname|WTUser pairs of users in group with given name

Parameters:
g - group name
dummy - class of map values to return, can be String.class or WTUser.class
ignoreCase - true/false if search should be conducted case insensitive

Returns:
map with user name/fullname|WTUser pairs

Throws:

thrown - if search with group name does not find exactly one goup

WTException

usersInGroup
```
public static HashMap<String,String> usersInGroup(WTGroup g)
                                           throws WTException
```
get a map with user name/fullname pairs of users in group - resolves groups in groups to users

Parameters:
g - group

Returns:
map with user name/fullname

Throws:

WTException

usersInGroup
```
public static <T> HashMap<String,T> usersInGroup(WTGroup g,
                                 Class<T> dummy)
                                      throws WTException
```
get a map with user name/fullname|WTUser pairs of users in group - resolves groups in groups to users

Parameters:
g - group
dummy - class of map values to return, can be String.class or WTUser.class

Returns:
map with user name/fullname|WTUser pairs

Throws:

WTException

usersInGroup2

public static <T> HashMap<String,T> usersInGroup2(WTGroup g,
                                  Class<T> dummy)
                                       throws Exception

Throws:: Exception

principalsInGroup
```
public static List<WTPrincipal> principalsInGroup(WTGroup g)
                                           throws WTException
```
get a map with user name/fullname|WTUser pairs of users in group - resolves groups in groups to users

Parameters:
g - group
dummy - class of map values to return, can be String.class or WTUser.class

Returns:
map with user WTPrincipals is returned

Throws:

WTException

parentGroups
```
public static List<WTGroup> parentGroups(WTPrincipal p)
                                  throws Exception
```
return the groups the principal is in

Parameters:
p - the principal

Returns:
List of WTGroups

Throws:

Exception

members
```
public static Vector members(WTGroup g,
             List<Persistable> alreadyChecked)
                      throws WTException
```
return a Vector with the group members - nested groups are resolved.

Parameters:
g - Group to get members for

Returns:
Vector with member users

Throws:

WTException

members2

public static Vector members2(WTGroup g,
              List<Persistable> alreadyChecked)
                       throws Exception

Throws:: Exception

memberGroups
```
public static List<WTGroup> memberGroups(WTGroup g)
                                  throws WTException
```
return a List of nested group members (only the members that are themselves a WTGroup)

Parameters:
g - Group to get members for

Returns:
List of member WTGroups

Throws:

WTException

setProcessDataVars
```
public static void setProcessDataVars(Object wfe,
                      Map<String,Object> vals)
                               throws Exception
```
set variable[s] in the ProcessData of a workflow execution object (e˙g˙, WorkItem, WfProcess) - NOTE: switches off access control to avoid access control problems!

Parameters:
wfe - the workflow object
vals - Map with key/values to set

Throws:

Exception

setProcessDataVar
```
public static void setProcessDataVar(Object wfe,
                     String varName,
                     Object val)
                              throws Exception
```
set variable in the ProcessData of a workflow exection object (e˙g˙, WorkItem, WfProcess)

Parameters:
wfe - the workflow object
varName - name of variable
val - value of variable

Throws:

Exception

getProcessDataVar
```
public static Object getProcessDataVar(Object wfe,
                       String varName)
                                throws Exception
```
get variable from the ProcessData of a workflow execution object (e˙g˙, WorkItem, WfProcess) - NOTE: switches off access control to avoid access control problems!

Parameters:
wfe - the workflow object
varName - name of variable

Returns:
value of variable

Throws:

Exception

delegate
```
public static void delegate(WorkItem w,
            WTUser u,
            String c)
                     throws Exception
```
delegate a workitem to another principal

Parameters:
w - the workitem
u - the new owner
c - comment for delegation

Throws:

Exception

getParentProcess
```
public static Object getParentProcess(WorkItem wi)
                               throws Exception
```
return parent process of workitem (NOTE: switches off access control to get the WfProcess)

Parameters:
wi - thw workitem

Returns:
the WfProcess

Throws:

Exception

getParentProcessVar

public static Object getParentProcessVar(WorkItem wi,
                         String varName)
                                  throws Exception

TODO javadoc

Parameters:: wi -; varName -
Returns:
Throws:: Exception

getParentProcess
```
public static WfProcess getParentProcess(WfActivity wfa)
                                  throws Exception
```
returns the parent process for a WfActivity

Parameters:
wfa - the WfActivity

Returns:
the WfProcess

Throws:

Exception

isAssignmentCompleted
```
public static Boolean isAssignmentCompleted(WfAssignedActivity wfa)
                                     throws Exception
```
tells if the WfAssignedActivity is complete

Parameters:
wfa - the WfAssignedActivity

Returns:
true if complete

Throws:

Exception