wt.inf.container
Interface WTContainerService

public interface WTContainerService

Supported API: true

Extendable: false

Method Summary

WTContainer	changePublicParentDomain(WTContainer container, AdminDomainRef new_parent) Changes a WTContainer's publicParentDomain property.
WTContainer	create(WTContainer container) Finds an appropriate WTContainerCreator for the given container and calls create().
boolean	createProfileGroup(String name, String description, WTContainer container) Supported API: true
void	deleteProfileGroup(WTGroup group) Supported API: true
void	disableProfileGroup(WTGroup group) Supported API: true
void	enableProfileGroup(WTGroup group) Supported API: true
AdminDomainRef	getBasePublicDomain(OrgContainer container, Class container_class) Returns the root public domain for containers of the given class.
WTPrincipal[]	getInternalGroups(wt.inf.container.PrincipalSpec principalSpec, String pattern) Supported API: true
String	getInternalGroupType(WTGroup internalGroup) This API is used to get the internal group type for to help in import/export of internal groups.
OrgContainer	getOrgContainer(WTOrganization wt_org) Find the OrgContainer for a WTOrganization Supported API: true
WTGroup	getProfileGroup(String name, WTContainer container) Supported API: true
Map	getProfileGroups(WTContainer container) Supported API: true
Map	getProfileGroupsForUser(WTUser user) Supported API: true
String	getProfileGroupType(WTGroup profileGroup) The API returns the type of the profile group.
PublicDomainSet	getPublicDomains(OrgContainer container, Class container_class) Finds all domains that can be used for a child container's publicParentDomain property.
WTContainer	makePrivate(WTContainer container) Sets the container's privateAccess property to true.
WTContainer	makePublic(WTContainer container) Sets the container's privateAccess property to false.
void	updateProfileGroup(WTGroup group) Supported API: true

Method Detail

changePublicParentDomain

WTContainer changePublicParentDomain(WTContainer container,
                                     AdminDomainRef new_parent)
                                     throws WTException

Changes a WTContainer's publicParentDomain property. The new domain must be included in those returned by getPublicDomains for the container's OrgContainer

Supported API: true

Parameters:

container -

new_parent -

Returns:

WTContainer

Throws:

WTException

enableProfileGroup

void enableProfileGroup(WTGroup group)
                        throws WTException

Supported API: true

Parameters:

group -

Throws:

WTException

create

WTContainer create(WTContainer container)
                   throws WTException

Finds an appropriate WTContainerCreator for the given container and calls create().

Supported API: true

Parameters:

container -

Returns:

WTContainer

Throws:

WTException

See Also:

WTContainerCreator

getBasePublicDomain

AdminDomainRef getBasePublicDomain(OrgContainer container,
                                   Class container_class)
                                   throws WTException

Returns the root public domain for containers of the given class. In the OOTB configuration, for products and repositories this will be a domain named "PDM" stored under the container's default domain, and for projects this will be a domain named "Project" stored under the container's default domain.

Supported API: true

Parameters:

container -

container_class -

Returns:

AdminDomainRef

Throws:

WTException

getOrgContainer

OrgContainer getOrgContainer(WTOrganization wt_org)
                             throws WTException

Find the OrgContainer for a WTOrganization

Supported API: true

Parameters:

wt_org -

Returns:

The associated OrgContainer, or null if one can't be found

Throws:

WTException

getPublicDomains

PublicDomainSet getPublicDomains(OrgContainer container,
                                 Class container_class)
                                 throws WTException

Finds all domains that can be used for a child container's publicParentDomain property. This includes the container's base domain for the given container class, as well as all children of the base domain that are also in the container.

Supported API: true

Parameters:

container -

container_class -

Returns:

PublicDomainSet

Throws:

WTException

makePrivate

WTContainer makePrivate(WTContainer container)
                        throws WTException

Sets the container's privateAccess property to true. In addition, reparents the container's defaultDomain to point to the org container's privateDomain.

Supported API: true

Parameters:

container -

Returns:

WTContainer

Throws:

WTException

makePublic

WTContainer makePublic(WTContainer container)
                       throws WTException

Sets the container's privateAccess property to false. In addition, reparents the container's defaultDomain to point to the domain stored in the container's publicParentDomain property.

Supported API: true

Parameters:

container -

Returns:

WTContainer

Throws:

WTException

getInternalGroups

WTPrincipal[] getInternalGroups(wt.inf.container.PrincipalSpec principalSpec,
                                String pattern)
                                throws WTException

Supported API: true

Parameters:

principalSpec -

pattern -

Returns:

WTPrincipal[]

Throws:

WTException

createProfileGroup

boolean createProfileGroup(String name,
                           String description,
                           WTContainer container)
                           throws WTException

Supported API: true

Parameters:

name -

description -

container -

Returns:

boolean

Throws:

WTException

getProfileGroup

WTGroup getProfileGroup(String name,
                        WTContainer container)
                        throws WTException

Supported API: true

Parameters:

name -

container -

Returns:

WTGroup

Throws:

WTException

getProfileGroups

Map getProfileGroups(WTContainer container)
                     throws WTException

Supported API: true

Parameters:

container -

Returns:

Map

Throws:

WTException

getProfileGroupsForUser

Map getProfileGroupsForUser(WTUser user)
                            throws WTException

Supported API: true

Parameters:

user -

Returns:

Map

Throws:

WTException

updateProfileGroup

void updateProfileGroup(WTGroup group)
                        throws WTException

Supported API: true

Parameters:

group -

Throws:

WTException

deleteProfileGroup

void deleteProfileGroup(WTGroup group)
                        throws WTException

Supported API: true

Parameters:

group -

Throws:

WTException

disableProfileGroup

void disableProfileGroup(WTGroup group)
                         throws WTException

Supported API: true

Parameters:

group -

Throws:

WTException

getInternalGroupType

String getInternalGroupType(WTGroup internalGroup)
                            throws WTException

This API is used to get the internal group type for to help in import/export of internal groups.

Supported API: true

Parameters:

internalGroup -

Returns:

String

Throws:

WTException

getProfileGroupType

String getProfileGroupType(WTGroup profileGroup)
                           throws WTException

The API returns the type of the profile group. The type could be either enabled or disabled.

Supported API: true

Parameters:

profileGroup -

Returns:

String

Throws:

WTException