wt.inf.team
Class ContainerTeamHelper

java.lang.Object
  wt.inf.team.ContainerTeamHelper

public class ContainerTeamHelper

extends Object

Selects the MyPageQueryables specified by the ContainerSpec

Supported API: true

Extendable: false

Nested Class Summary

private static class

ContainerTeamHelper.MembershipClasses

Field Summary

static String	ACCESS_GROUPS Supported API: false
static String	ALL
private static String	CLASSNAME
static String	CONFIRMED Supported API: false
private static boolean	DEBUG
static String	DEFAULT_ROLE Supported API: false
static String	GUEST Supported API: false
private static String	INVALID_CHARACTERS_FOR_ROLE_NAME
static String	INVITED Supported API: false
private static DebugWriter	LOG
static String	MEMBERSHIP_GROUPS Supported API: false
static String	MY_PAGE_QUERYABLE Supported API: false
protected static String	ORG_GROUP_SUFFIX When the system generates an 'Organization' group, name of that group is set to the organization name + this constant.
static String	ORG_GROUPS Supported API: false
static String	OTHER_GROUPS Supported API: false
private static String	RESOURCE
static String	ROLE_GROUPS Supported API: false
static ContainerTeamService	service Supported API: false
static String	USERS Supported API: false
private static boolean	VERBOSE
private static int[]	ZERO

Constructor Summary

ContainerTeamHelper()

Method Summary

private static String	checkAccessToObject(AccessControlled object, Locale locale)
static Role	getDefaultRole() Supported API: true
static String	getDisplayName(WTGroup group) Deprecated. at 7.0
static String	getDisplayName(WTGroup group, Locale locale) Supported API: false
static QuerySpec	getMembershipQuery(ContainerSpec spec) Supported API: false
protected static QuerySpec	getMembershipQuery(ContainerSpec spec, int membership_state)
static WhereExpression	getWhereStateIs(ContainerTeamManagedState state) Supported API: false
static ContainerTeamManaged	setAllowUserToConfigureAccess(ContainerTeamManaged container, boolean allowUserToConfigureAccess) Supported API: true
static ContainerTeamManaged	setContainerTeam(ContainerTeamManaged object, ContainerTeam containerTeam) Set the ContainerTeam of the ContainerTeamManaged object..
static ContainerTeamManaged	setContainerTeam(ContainerTeamManaged object, ContainerTeamReference ctRef) Set the ContainerTeam of the ContainerTeamManaged object.
static ContainerTeamManaged	setRequireConfirmation(ContainerTeamManaged container, boolean requireConfirmation) Supported API: true
static ContainerTeamManaged	setSendInvitations(ContainerTeamManaged container, boolean sendInvitations) Supported API: true
static void	validateRoleName(String roleName) Verify that the String representation of the role name does not contain any 'invalid' special characters.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

ORG_GROUP_SUFFIX

protected static final String ORG_GROUP_SUFFIX

When the system generates an 'Organization' group, name of that group is set to the organization name + this constant. This is required to prevent collisions between the role group names and organization groups names. Although unlikely, it is possible to have organizations and roles by the same name.

Supported API: false

See Also:

Constant Field Values

ACCESS_GROUPS

public static final String ACCESS_GROUPS

Supported API: false

See Also:

Constant Field Values

MEMBERSHIP_GROUPS

public static final String MEMBERSHIP_GROUPS

Supported API: false

See Also:

Constant Field Values

ROLE_GROUPS

public static final String ROLE_GROUPS

Supported API: false

See Also:

Constant Field Values

ORG_GROUPS

public static final String ORG_GROUPS

Supported API: false

See Also:

Constant Field Values

OTHER_GROUPS

public static final String OTHER_GROUPS

Supported API: false

See Also:

Constant Field Values

GUEST

public static final String GUEST

Supported API: false

See Also:

Constant Field Values

CONFIRMED

public static final String CONFIRMED

Supported API: false

See Also:

Constant Field Values

USERS

public static final String USERS

Supported API: false

See Also:

Constant Field Values

INVITED

public static final String INVITED

Supported API: false

See Also:

Constant Field Values

MY_PAGE_QUERYABLE

public static final String MY_PAGE_QUERYABLE

Supported API: false

See Also:

Constant Field Values

DEFAULT_ROLE

public static final String DEFAULT_ROLE

Supported API: false

service

public static final ContainerTeamService service

Supported API: false

DEBUG

private static final boolean DEBUG

LOG

private static final DebugWriter LOG

ALL

public static final String ALL

See Also:

Constant Field Values

ZERO

private static final int[] ZERO

VERBOSE

private static boolean VERBOSE

INVALID_CHARACTERS_FOR_ROLE_NAME

private static String INVALID_CHARACTERS_FOR_ROLE_NAME

Constructor Detail

ContainerTeamHelper

public ContainerTeamHelper()

Method Detail

getMembershipQuery

public static QuerySpec getMembershipQuery(ContainerSpec spec)
                                    throws WTException

Supported API: false

Parameters:

spec -

Returns:

QuerySpec

Throws:

WTException

setContainerTeam

public static ContainerTeamManaged setContainerTeam(ContainerTeamManaged object,
                                                    ContainerTeam containerTeam)
                                             throws WTException,
                                                    WTPropertyVetoException

Set the ContainerTeam of the ContainerTeamManaged object.. If the object is already persisted, this method will throw an exception.

Supported API: true

Parameters:

object - the ContainerTeamManaged object whose containerTeam will be set

containerTeam - the containerTeam to be set on the ContainerTeamManaged object.

Returns:

ContainerTeamManaged

Throws:

WTException

WTPropertyVetoException

setContainerTeam

public static ContainerTeamManaged setContainerTeam(ContainerTeamManaged object,
                                                    ContainerTeamReference ctRef)
                                             throws WTException,
                                                    WTPropertyVetoException

Set the ContainerTeam of the ContainerTeamManaged object. If the object is already persisted, this method will throw an exception.

Supported API: true

Parameters:

object - the ContainerTeamManaged object whose container team should be set

ctRef - the ContainerTeamReference of the ContainerTeam that should be set on the ContainerTeamManaged object.

Returns:

ContainerTeamManaged

Throws:

WTException

WTPropertyVetoException

getDisplayName

public static String getDisplayName(WTGroup group)

Deprecated. at 7.0

Given a group, determine the display name. This is particularily useful for groups that are generated by the system and various strings are appended together. For Organization Groups, the Organization name is returned. For Role groups, the display name for that role entry is returned. For any other group, a resource bundle lookup is done. In all other cases, the group name on the object is returned.

Supported API: false

Parameters:

group -

Returns:

String

getDisplayName

public static String getDisplayName(WTGroup group,
                                    Locale locale)

Supported API: false

Parameters:

group -

locale -

Returns:

String

validateRoleName

public static void validateRoleName(String roleName)
                             throws WTException

Verify that the String representation of the role name does not contain any 'invalid' special characters. The list of invalid special characters are pulled from a wt.properties entry.

Supported API: false

Parameters:

roleName -

Throws:

WTException

getWhereStateIs

public static WhereExpression getWhereStateIs(ContainerTeamManagedState state)
                                       throws WTException

Supported API: false

Parameters:

state -

Returns:

WhereExpression

Throws:

WTException

setRequireConfirmation

public static ContainerTeamManaged setRequireConfirmation(ContainerTeamManaged container,
                                                          boolean requireConfirmation)
                                                   throws WTException,
                                                          WTPropertyVetoException

Supported API: true

Parameters:

container -

requireConfirmation -

Returns:

ContainerTeamManaged

Throws:

WTException

WTPropertyVetoException

setSendInvitations

public static ContainerTeamManaged setSendInvitations(ContainerTeamManaged container,
                                                      boolean sendInvitations)
                                               throws WTException,
                                                      WTPropertyVetoException

Supported API: true

Parameters:

container - the ContainerTeamManaged object whose containerTeam will be set

sendInvitations - the containerTeam to be set on the ContainerTeamManaged object.

Returns:

ContainerTeamManaged

Throws:

WTException

WTPropertyVetoException

setAllowUserToConfigureAccess

public static ContainerTeamManaged setAllowUserToConfigureAccess(ContainerTeamManaged container,
                                                                 boolean allowUserToConfigureAccess)
                                                          throws WTException,
                                                                 WTPropertyVetoException

Supported API: true

Parameters:

container -

allowUserToConfigureAccess -

Returns:

ContainerTeamManaged

Throws:

WTException

WTPropertyVetoException

getDefaultRole

public static Role getDefaultRole()

Supported API: true

Returns:

Role

getMembershipQuery

protected static QuerySpec getMembershipQuery(ContainerSpec spec,
                                              int membership_state)
                                       throws WTException

Throws:

WTException

checkAccessToObject

private static String checkAccessToObject(AccessControlled object,
                                          Locale locale)
                                   throws WTException

Throws:

WTException