com.ibm.team.scm.common

Interface IComponent

All Superinterfaces:

IAuditable, IAuditableHandle, IComponentHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle

public interface IComponent
extends IComponentHandle, IAuditable

Represents a component known to the repository.

Feature access profile values:

• name: SMALL
• root folder: DEFAULT

Since:

0.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INITIAL_BASELINE_NAME Name of the initial baseline.
static java.lang.String	INITIAL_BASELINE_PROPERTY The initial baseline property.
static IItemType	ITEM_TYPE Component item type.
static java.lang.String	NAME_PROPERTY The name property.
static java.lang.String	ROOT_FOLDER_PROPERTY The root folder property.

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.Map<java.lang.String,java.lang.Object>	getCustomAttributes() Get custom attributes.
IBaselineHandle	getInitialBaseline() Returns the initial baseline of this component.
java.lang.String	getName() Returns the component name.
IFolderHandle	getRootFolder() Returns the root folder of this component.

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

Component item type.

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

The name property.

See Also:

getName()

ROOT_FOLDER_PROPERTY

static final java.lang.String ROOT_FOLDER_PROPERTY

The root folder property.

See Also:

getRootFolder()

INITIAL_BASELINE_PROPERTY

static final java.lang.String INITIAL_BASELINE_PROPERTY

The initial baseline property.

See Also:

getInitialBaseline()

INITIAL_BASELINE_NAME

static final java.lang.String INITIAL_BASELINE_NAME

Name of the initial baseline.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the component name.

Returns:

the name; never null

getRootFolder

IFolderHandle getRootFolder()

Returns the root folder of this component.

The party that initially creates the component's root folder (in some workspace) is responsible for recording it with the component.

TODO Issue: In the world of siloed components, the root folder for a component exists in the initial configuration. If two parties each add the same new component to separate workspaces (in separate repos) using addComponent(IComponent), we need to ensure that they both end up with the same root folder item. Otherwise, the two components will never be commensurable, and change sets that work for one may not work for the other. The solution is to assign a root folder item id at component creation time; i.e., in the implementation of IItemFactory.createComponent(IAudtiable,String), or, better still, in the EMF factory method so that we can initialize components created by IItemFactory.createAuditable.

Returns:

this component's root folder, or null if none

getInitialBaseline

IBaselineHandle getInitialBaseline()

Returns the initial baseline of this component. The configuration of the initial baseline contains only the (empty) root folder. The initial baseline is created when the Component is created (using IWorkspaceManager.createComponent).

Returns:

handle of the initial baseline value of the component (will not be null)

getCustomAttributes

java.util.Map<java.lang.String,java.lang.Object> getCustomAttributes()

Get custom attributes.

Returns:

Custom attributes. The attribute value can be either Boolean, Integer, Timestamp, or String. Never null.