public interface IChangeSet extends IChangeSetHandle, IAuditable
A change set has a unique id (UUID
) and changes (check-ins, comment
changes, etc.) create new change set states. There is a current state and
all other states provide an audit trail (see IAuditable
for more
details).
Since configurations are typically large, and change sets typically, the standard usage is to explicitly construct a change set that can be applied to a configuration. Computing a change set by diffing two configurations to not done for reasons of performance (although it would make sense in principle to do so).
Note that there are no operations on IChangeSet
that modify
the change set directly. A change set gets constructed and modified
indirectly in the course of changing files, folders, and other versionable
items in a workspace. When an aspect of the change set is modified, a new
state of the change set is created. Clients are not permitted to save
change
sets. They are, however, allowed to retrieve a change set with
fetchCurrent
, fetchState
, etc.
IAuditable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTIVE_PROPERTY
The active property.
|
static java.lang.String |
AUTHOR_PROPERTY
The author property.
|
static java.lang.String |
CHANGES_PROPERTY
The changes property.
|
static java.lang.String |
COMMENT_PROPERTY
The comment property.
|
static java.lang.String |
COMPONENT_PROPERTY
The component property.
|
static IItemType |
ITEM_TYPE
Change set item type.
|
static java.lang.String |
LAST_CHANGED_DATE_PROPERTY
The last changed date property.
|
MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY
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
Modifier and Type | Method and Description |
---|---|
java.util.List |
changes()
Returns the set of changes in this change set.
|
IContributorHandle |
getAuthor()
Returns a contributor handle identifying the contributor whom is considered the
author of the change set.
|
java.lang.String |
getComment()
Returns the comment for this change set.
|
IComponentHandle |
getComponent()
Returns the component associated with this change set.
|
java.util.Date |
getLastChangeDate()
Returns the time in which this change set was last changed in the context of a workspace.
|
IChangeSetHandle |
getOriginalChangeSet()
The original change set ported resulting in the group of change sets with the same port id.
|
UUID |
getOriginalSourceId()
Returns the logical id that can be used to group this change set with other
change sets porting the same logical change set.
|
IChangeSetHandle |
getSourceChangeSet() |
boolean |
isActive()
Returns whether this change set is an active change set or not.
|
getMergePredecessorState, getPredecessorState
isNewItem
getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId
equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size
static final IItemType ITEM_TYPE
static final java.lang.String CHANGES_PROPERTY
changes()
static final java.lang.String COMPONENT_PROPERTY
getComponent()
static final java.lang.String ACTIVE_PROPERTY
isActive()
static final java.lang.String COMMENT_PROPERTY
getComment()
static final java.lang.String AUTHOR_PROPERTY
getAuthor()
static final java.lang.String LAST_CHANGED_DATE_PROPERTY
getLastChangeDate()
java.lang.String getComment()
null
java.util.List changes()
IChange
); the elements
are in no particular order; each entry is for a distinct
versionable item; never null
IComponentHandle getComponent()
null
boolean isActive()
IContributorHandle getAuthor()
null
java.util.Date getLastChangeDate()
null
UUID getOriginalSourceId()
null
if this change set is not a port of another change set (or has never been ported).IChangeSetHandle getSourceChangeSet()
null
if this change set does not represent a port or if the source of the port was something other
than a change set.IChangeSetHandle getOriginalChangeSet()
getSourceChangeSet()
.
If this is a port of a port of a ... this is the change set that was originally ported at the very
beginning.null
if this change
set or has never been ported or if the source of the port was something other
than a change set.