com.ibm.team.workitem.common.model

Interface ICategory

All Superinterfaces:

IAuditable, IAuditableHandle, ICategoryHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle, IProjectScoped

public interface ICategory
extends ICategoryHandle, IAuditable, IProjectScoped

A category of work items. Categories are organized in a tree within each project area and represent functional areas of different granularity. For each development line a category is owned by a team which determines the process used for work items filed against that category. A work item's development line is given by the iteration it is planned for. If a work item is not planned for an iteration the default team area's process is used.

Since:

0.5

See Also:

IWorkItem.getCategory(), IWorkItem.getTarget(), IWorkItemCommon.findProcessArea(IWorkItemHandle, IProgressMonitor)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVED_PROPERTY The archived property, see isArchived().
static java.util.Collection<java.lang.String>	ASSOCIATED_TEAM_AREAS_PROPERTIES The associated team areas properties, see getAssociatedTeamAreas()
static java.lang.String	CATEGORY_ID The category id property, see getCategoryId().
static java.lang.String	DEFAULT_CATEGORY_PROPERTY The default property, see #isDefault().
static ItemProfile<ICategory>	DEFAULT_PROFILE
static java.lang.String	DESCRIPTION_PROPERTY The description property, see getHTMLDescription().
static java.lang.String	FILTERED_PROPERTY The filtered property, see isFiltered().
static ItemProfile<ICategory>	FULL_PROFILE The full item profile.
static IItemType	ITEM_TYPE The category item type.
static ItemProfile<ICategory>	LARGE_PROFILE
static ItemProfile<ICategory>	MEDIUM_PROFILE
static java.lang.String	NAME_PROPERTY The name property, see getName().
static java.lang.String	PROJECT_AREA_PROPERTY The project area property, see getProjectArea().
static java.lang.String	READ_ACCESS_ENABLED_PROPERTY The read access property, see isReadAccessEnabled().
static ItemProfile<ICategory>	SMALL_PROFILE

Fields inherited from interface com.ibm.team.repository.common.IAuditable

MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY

Fields inherited from interface com.ibm.team.repository.common.IItem

CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ITeamAreaHandle>	getAssociatedTeamAreas() Returns the list of associated team areas.
CategoryId	getCategoryId() Returns the identifier, unique within a project area.
ITeamAreaHandle	getDefaultTeamArea() Returns the default team area that is used when a work item is not planned for an iteration.
int	getDepth()
java.lang.String	getHierarchicalName() Deprecated. use IWorkItemCommon.resolveHierarchicalName(ICategoryHandle, org.eclipse.core.runtime.IProgressMonitor) instead
com.ibm.team.foundation.common.text.XMLString	getHTMLDescription() Returns the description.
java.lang.String	getName() Returns the name suitable for presenting it as part of a label to the user.
CategoryId	getParentId() Deprecated. use getParentId2() instead, which returns the root category id where this returns null
CategoryId	getParentId2() Returns the parent identifier.
IProjectAreaHandle	getProjectArea() Returns the project area this category belongs to.
java.util.List<ITeamAreaHandle>	getTeamAreas() Deprecated. use read-only getAssociatedTeamAreas() which also contains the "default team area"
boolean	isArchived() Returns true iff the category is archived and should no longer be used.
boolean	isDefaultCategory() Returns true if the category is specified as a default for the mapped team area
boolean	isFiltered() Returns true if the category should be hidden from contributors not part of any associated team in the category subtree.
boolean	isReadAccessEnabled() Returns true iff this category is marked for team area based read access control
boolean	isSetDefaultTeamArea()
boolean	isUnassigned() Returns true iff this is the 'unassigned' category which is unique within a project area.
void	setArchived(boolean value) Deprecated. internal
void	setHTMLDescription(com.ibm.team.foundation.common.text.XMLString value) Sets the description to the given xml string.
void	setName(java.lang.String value) Deprecated. use com.ibm.team.workitem.service.IWorkItemServer#renameCategory(ICategoryHandle, String, IProgressMonitor) instead

Methods inherited from interface com.ibm.team.repository.common.IAuditable

getMergePredecessorState, getPredecessorState

Methods inherited from interface com.ibm.team.repository.common.IManagedItem

isNewItem

Methods inherited from interface com.ibm.team.repository.common.IItem

getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId

Methods inherited from interface com.ibm.team.repository.common.IItemHandle

equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size

Field Detail

ITEM_TYPE

static final IItemType ITEM_TYPE

The category item type.

PROJECT_AREA_PROPERTY

static final java.lang.String PROJECT_AREA_PROPERTY

The project area property, see getProjectArea().

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

The name property, see getName().

DESCRIPTION_PROPERTY

static final java.lang.String DESCRIPTION_PROPERTY

The description property, see getHTMLDescription().

CATEGORY_ID

static final java.lang.String CATEGORY_ID

The category id property, see getCategoryId().

FILTERED_PROPERTY

static final java.lang.String FILTERED_PROPERTY

The filtered property, see isFiltered().

ARCHIVED_PROPERTY

static final java.lang.String ARCHIVED_PROPERTY

The archived property, see isArchived().

DEFAULT_CATEGORY_PROPERTY

static final java.lang.String DEFAULT_CATEGORY_PROPERTY

The default property, see #isDefault().

READ_ACCESS_ENABLED_PROPERTY

static final java.lang.String READ_ACCESS_ENABLED_PROPERTY

The read access property, see isReadAccessEnabled().

ASSOCIATED_TEAM_AREAS_PROPERTIES

static final java.util.Collection<java.lang.String> ASSOCIATED_TEAM_AREAS_PROPERTIES

The associated team areas properties, see getAssociatedTeamAreas()

SMALL_PROFILE

static final ItemProfile<ICategory> SMALL_PROFILE

DEFAULT_PROFILE

static final ItemProfile<ICategory> DEFAULT_PROFILE

MEDIUM_PROFILE

static final ItemProfile<ICategory> MEDIUM_PROFILE

LARGE_PROFILE

static final ItemProfile<ICategory> LARGE_PROFILE

FULL_PROFILE

static final ItemProfile<ICategory> FULL_PROFILE

The full item profile.

Method Detail

getProjectArea

IProjectAreaHandle getProjectArea()

Returns the project area this category belongs to.

Specified by:

getProjectArea in interface IProjectScoped

Returns:

the project area

getCategoryId

CategoryId getCategoryId()

Returns the identifier, unique within a project area.

Returns:

the identifier

getName

java.lang.String getName()

Returns the name suitable for presenting it as part of a label to the user.

Returns:

the name

See Also:

IWorkItemCommon.resolveHierarchicalName(ICategoryHandle, IProgressMonitor)

getHTMLDescription

com.ibm.team.foundation.common.text.XMLString getHTMLDescription()

Returns the description.

Returns:

the description

setHTMLDescription

void setHTMLDescription(com.ibm.team.foundation.common.text.XMLString value)

Sets the description to the given xml string.

Parameters:

value - the new description

getDepth

int getDepth()

getParentId2

CategoryId getParentId2()

Returns the parent identifier.

Returns:

the parent identifier

getAssociatedTeamAreas

java.util.List<ITeamAreaHandle> getAssociatedTeamAreas()

Returns the list of associated team areas. There should be only one team area for each development line, but this can currently not be enforced.

Returns:

the list of associated team areas

getDefaultTeamArea

ITeamAreaHandle getDefaultTeamArea()

Returns the default team area that is used when a work item is not planned for an iteration.
This method may throw IllegalStateException exception if the setDefaultTeamArea() was not called.
The isSetDefaultTeamArea() should be used first to avoid the exception.

Returns:

the default team area

isSetDefaultTeamArea

boolean isSetDefaultTeamArea()

Returns:

true if the default team area was set for the category.

isFiltered

boolean isFiltered()

Returns true if the category should be hidden from contributors not part of any associated team in the category subtree.

Returns:

true if the category should be hidden from unaffiliated contributors

isDefaultCategory

boolean isDefaultCategory()

Returns true if the category is specified as a default for the mapped team area

Returns:

true if the category is marked as default

isArchived

boolean isArchived()

Returns true iff the category is archived and should no longer be used.

Returns:

true iff the category is archived

isUnassigned

boolean isUnassigned()

Returns true iff this is the 'unassigned' category which is unique within a project area.

Returns:

true iff this is the 'unassigned' category

isReadAccessEnabled

boolean isReadAccessEnabled()

Returns true iff this category is marked for team area based read access control

Returns:

true iff the category is marked for access control

getHierarchicalName

@Deprecated
java.lang.String getHierarchicalName()

Deprecated. use IWorkItemCommon.resolveHierarchicalName(ICategoryHandle, org.eclipse.core.runtime.IProgressMonitor) instead

getTeamAreas

@Deprecated
java.util.List<ITeamAreaHandle> getTeamAreas()

Deprecated. use read-only getAssociatedTeamAreas() which also contains the "default team area"

setArchived

@Deprecated
void setArchived(boolean value)

Deprecated. internal

getParentId

@Deprecated
CategoryId getParentId()

Deprecated. use getParentId2() instead, which returns the root category id where this returns null

setName

@Deprecated
void setName(java.lang.String value)

Deprecated. use com.ibm.team.workitem.service.IWorkItemServer#renameCategory(ICategoryHandle, String, IProgressMonitor) instead