Package com.polarion.alm.projects.model

Interface IProjectGroup

All Superinterfaces:

IAdaptable, IChangeListener, IGroupEntity, IHasCustomValues, IHasValues, ILocatedObject, IPObject

public interface IProjectGroup
extends IGroupEntity

IPObject representation of project group. Project goups form tree hierarchy, with projects being the leafs of this tree.

Note: Projects and project groups are available as IPObjects so that it's easy to read them and manipulate some of their properties. However, they encapsulate lower level objects and therefore it's not possible to create and delete projects by the means of standard IPObject ways. The project group location is extracted from a context of the project group.

Author:

dobisekm

See Also:

• IProject

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_GROUPS
static final String	KEY_NAME
static final String	KEY_PARENT
static final String	KEY_PROJECTS
static final String	PROTO

Fields inherited from interface com.polarion.alm.projects.model.ILocatedObject

KEY_LOCATION

Method Summary

Modifier and Type	Method	Description
IPObjectList<IProjectGroup>	getContainedGroups()
IPObjectList	getContainedProjects()
IPObjectList<IProject>	getDeepContainedProjects()	This method performs a recursive search for all contained projects.
String	getName()	The project group name is generated from a location of a project group
IProjectGroup	getParentProjectGroup()
IPObjectList	getSortedContainedGroups()	Returns list of groups contained in this project group sorted by name.
IPObjectList	getSortedContainedProjects()
IPObjectList	getSortedDeepContainedProjects()

Methods inherited from interface com.polarion.platform.persistence.model.IAdaptable

adapt

Methods inherited from interface com.polarion.platform.persistence.model.IChangeListener

markChanged

Methods inherited from interface com.polarion.platform.persistence.model.IHasCustomValues

getCustomField, getCustomFieldPrototype, getCustomFieldsList, setCustomField

Methods inherited from interface com.polarion.alm.projects.model.ILocatedObject

getLocation

Methods inherited from interface com.polarion.platform.persistence.model.IPObject

can, copyTo, createStructureForKey, forget, getContextId, getDataRevision, getDataSvc, getEnumerationOptionForField, getEnumerationTypeForField, getFieldLabel, getFieldType, getIncompatibleCustomField, getIncompatibleCustomFieldPrototype, getIncompatibleCustomFieldsList, getLastRevision, getLocalId, getObjectId, getPrototype, getRevision, getUri, getValue, isModified, isPersisted, isReadOnly, isResolved, isUnresolvable, resolve, save, setEnumerationValue, setValue, update

Field Details

PROTO

static final String PROTO

See Also:

• Constant Field Values

KEY_PARENT

static final String KEY_PARENT

See Also:

• Constant Field Values

KEY_PROJECTS

static final String KEY_PROJECTS

See Also:

• Constant Field Values

KEY_GROUPS

static final String KEY_GROUPS

See Also:

• Constant Field Values

KEY_NAME

static final String KEY_NAME

See Also:

• Constant Field Values

Method Details

getParentProjectGroup

IProjectGroup getParentProjectGroup()

getContainedProjects

IPObjectList getContainedProjects()

getSortedContainedProjects

IPObjectList getSortedContainedProjects()

getSortedDeepContainedProjects

IPObjectList getSortedDeepContainedProjects()

getDeepContainedProjects

@NotNull
IPObjectList<IProject> getDeepContainedProjects()

This method performs a recursive search for all contained projects.

The result of this method might be expensive to calculate and is NOT cached by the IProjectGroup.

Returns:

a IPObjectList containing IProjects

getName

String getName()

The project group name is generated from a location of a project group

Returns:

the name of a project group

getContainedGroups

@NotNull
IPObjectList<IProjectGroup> getContainedGroups()

Returns:

list of IProjectGroup contained in the project group

getSortedContainedGroups

IPObjectList getSortedContainedGroups()

Returns list of groups contained in this project group sorted by name.

Returns:

list of IProjectGroup (not null)