com.ibm.team.process.common

Interface IAccessGroup

All Superinterfaces:

IAccessGroupHandle, IAuditable, IAuditableHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle

public interface IAccessGroup
extends IAccessGroupHandle, IAuditable

An access group represents a group of items that are used as a context to provide read access to one or more items.

Since:

1.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IAccessGroup.ReadAccessContextType Represents the types of read access contexts that can be maintained by the members that make up the group

Field Summary

Fields

Modifier and Type	Field and Description
static IItemType	ITEM_TYPE The access group item type.

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
void	add(IContributorHandle contributorHandle) Adds a contributor to the access group.
void	add(IProcessAreaHandle processAreaHandle, IAccessGroup.ReadAccessContextType contextType) Adds a process area to the access group.
java.lang.String	getDescription() Retrieves the description of the access group.
UUID	getGroupContextId() Retrieves the context id that represents members that make up the group.
IItemHandle[]	getItems() Retrieves the items that make up the context members of the access group.
IAccessGroupMember[]	getMembers() Retrieves the members of the access group.
java.lang.String	getName() Retrieves the name of the access group.
java.lang.String	getOwningApplicationKey() Retrieves the owning application key for the access group
boolean	isArchived() Indicates whether the access group is in an archived state.
void	remove(IAccessGroupMember member) Removes an access group member from the access group.
void	remove(IContributorHandle contributorHandle) Removes a contributor from the access group.
void	remove(IProcessAreaHandle processAreaHandle) Removes a process area from the access group.
void	setDescription(java.lang.String description) Sets the description of the access group.
void	setName(java.lang.String name) Sets the name of the access group.

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 access group item type.

Method Detail

isArchived

boolean isArchived()

Indicates whether the access group is in an archived state.

Returns:

true if the access group is in an archived state.

getName

java.lang.String getName()

Retrieves the name of the access group.

Returns:

the name of the access group.

setName

void setName(java.lang.String name)

Sets the name of the access group.

getDescription

java.lang.String getDescription()

Retrieves the description of the access group.

Returns:

the description of the access group.

setDescription

void setDescription(java.lang.String description)

Sets the description of the access group.

getItems

IItemHandle[] getItems()

Retrieves the items that make up the context members of the access group. It is a convenience method that simple returns only the item handles that would be returned in the call to getMembers().

Returns:

the items that make up the context members of the access group.

getMembers

IAccessGroupMember[] getMembers()

Retrieves the members of the access group.

Returns:

the members of the access group.

add

void add(IContributorHandle contributorHandle)

Adds a contributor to the access group.

Parameters:

contributorHandle - the contributor to add to the access group.

add

void add(IProcessAreaHandle processAreaHandle,
       IAccessGroup.ReadAccessContextType contextType)
         throws java.lang.IllegalArgumentException

Adds a process area to the access group.

Parameters:

processAreaHandle - the process area to add to the access group.

contextType - The context in which the process area should be add

Throws:

java.lang.IllegalArgumentException - if IAccessGroup.ReadAccessContextType enum value of CONTRIBUTOR is used as the context type

remove

void remove(IContributorHandle contributorHandle)

Removes a contributor from the access group.

Parameters:

contributorHandle - the contributor to remove from the access group.

remove

void remove(IProcessAreaHandle processAreaHandle)

Removes a process area from the access group.

Parameters:

processAreaHandle - the process area to remove from the access group.

remove

void remove(IAccessGroupMember member)

Removes an access group member from the access group.

Parameters:

member - the member to remove from the access group

getGroupContextId

UUID getGroupContextId()

Retrieves the context id that represents members that make up the group. It may or may not be the same value as the context id for the access group item itself.

Returns:

The context id that represents members that make up the group

getOwningApplicationKey

java.lang.String getOwningApplicationKey()

Retrieves the owning application key for the access group

Returns:

the owning application key for the access group