com.starteam
Class ChangePackage.WebCacheChangePackage

java.lang.Object
  com.starteam.LiveObject.WebCacheLiveObject
      com.starteam.TrackedObject.WebCacheTrackedObject
          com.starteam.VersionedObject.WebCacheVersionedObject
              com.starteam.ViewMember.WebCacheViewMember
                  com.starteam.ChangePackage.WebCacheChangePackage

All Implemented Interfaces:

ArtifactCacheManager.Securable

Enclosing class:

ChangePackage

public static class ChangePackage.WebCacheChangePackage
extends ViewMember.WebCacheViewMember

ChangePackage accessor for cached SDK ChangePackages contained objects are obtained from the artifact cache

Method Summary

Change.WebCacheChange[]	getChanges() Gets the Change objects associated with this change package.
Transaction.WebCacheTransaction	getCommitTransaction() The transaction in which this change package was committed, or null if it hasn't been committed yet.
java.lang.String	getDescription() Provides a full description of the change package.
java.lang.String	getName() Each change package has a name that serves as a textual identification of the change package.
Label.WebCacheLabel	getPostCommitRevisionLabel() The post-commit revision label, or null.
Label.WebCacheLabel	getPostCommitViewLabel() The post-commit view label.
Label.WebCacheLabel	getPreCommitRevisionLabel() The pre-commit revision label.
Label.WebCacheLabel	getPreCommitViewLabel() The pre-commit view label.
User.WebCacheUser	getResponsibility() Gets the user who is currently responsible for this change package.
ChangePackage.SessionType	getSessionType() Defines the session type for the change package.
View.WebCacheView	getSourceView() The source view for this change package.
ChangePackage.State	getState() Gets the current workflow state of the change package.
View.WebCacheView	getTargetView() The target view for this change package.
boolean	isActive() Returns true if this is an active ChangePackage
boolean	isCommitted() Returns true if this is a committed ChangePackage
boolean	isMyResponsibility() Returns true if the logged in user is responsible for this ChangePackage
java.lang.String	toString() Returns the ChangePackage name.

Methods inherited from class com.starteam.ViewMember.WebCacheViewMember

getAttachments, getComment, getDisplayValue, getDotNotation, getExternalID, getExternalURL, getHistory, getLocker, getPresentationID, getRights, getShareTree, getTraces, getView, isDeleted, isFloating, isPinned, isUnread, lock, lock, modifyReadStatus, pinTo, setAttachments, setExternalID, setExternalURL, setRights, unlock, unpin, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject.WebCacheVersionedObject

getRevisionNumber, getRootObjectID, getViewVersion, isFromHistory

Methods inherited from class com.starteam.TrackedObject.WebCacheTrackedObject

getModifiedBy, getModifiedTime

Methods inherited from class com.starteam.LiveObject.WebCacheLiveObject

addTo, equals, getContext, getCreatedBy, getCreatedTime, getDisplayName, getID, getObjectID, getServer, getType, getValue, getValue, hashCode, hasValue, isDirty, isNew, refresh, remove, removeFrom, setValue, setValue, toStarTeamURL, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Each change package has a name that serves as a textual identification of the change package. By default, StarTeam generates a name that contains a timestamp, which helps prevent duplicate names. This property is the primary descriptor of the change package object.

Returns:

String

getDescription

public java.lang.String getDescription()

Provides a full description of the change package. A typical use of the description is to provide documentation not available in the process item attached to the change package, such as notes to testers, reviewers, or developers.

Returns:

String

getSessionType

public ChangePackage.SessionType getSessionType()

Defines the session type for the change package. One of: Promote, Rebase, Replicate or Checkin.

Returns:

ChangePackage.SessionType

getSourceView

public View.WebCacheView getSourceView()

The source view for this change package.

Returns:

View

getTargetView

public View.WebCacheView getTargetView()

The target view for this change package.

Returns:

View

getState

public ChangePackage.State getState()

Gets the current workflow state of the change package.

Returns:

ChangePackage.State

getResponsibility

public User.WebCacheUser getResponsibility()

Gets the user who is currently responsible for this change package. Returns null if no one is currently responsible. Note that the responsible user may be a deleted user.

Returns:

User

isMyResponsibility

public boolean isMyResponsibility()

Returns true if the logged in user is responsible for this ChangePackage

Returns:

true if the logged in user is responsible for this ChangePackage

getCommitTransaction

public Transaction.WebCacheTransaction getCommitTransaction()

The transaction in which this change package was committed, or null if it hasn't been committed yet.

Returns:

Transaction

isActive

public boolean isActive()

Returns true if this is an active ChangePackage

Returns:

true if this is an active ChangePackage

isCommitted

public boolean isCommitted()

Returns true if this is a committed ChangePackage

Returns:

true if this is a committed ChangePackage

getPreCommitViewLabel

public Label.WebCacheLabel getPreCommitViewLabel()

The pre-commit view label. This label shows the initial state of the target view, before any changes were committed.

Returns:

The pre-commit view label, or null if changes have not been committed or this label was not enabled when the changes were committed.

See Also:

Session.isPreCommitViewLabelEnabled

getPostCommitViewLabel

public Label.WebCacheLabel getPostCommitViewLabel()

The post-commit view label. This label shows the state of the target view just after the changes are committed.

The label is created at the start of the commit, and is updated as each change is merged to the target view. The difference between the pre- and post-commit view labels shows exactly which items were changed in the target view.

Returns:

The post-commit view label, or null if changes have not been committed or this label was not enabled when the changes were committed.

See Also:

Session.isPostCommitViewLabelEnabled

getPreCommitRevisionLabel

public Label.WebCacheLabel getPreCommitRevisionLabel()

The pre-commit revision label.

This label is attached only to items that are changed or removed during the commit. It is attached to the item revision that is current prior to making the change.

The label will be created during the commit transaction, if the option is enabled.

Returns:

The pre-commit revision label, or null if changes have not been committed or this label was not enabled when the changes were committed.

See Also:

Session.isPreCommitRevisionLabelEnabled

getPostCommitRevisionLabel

public Label.WebCacheLabel getPostCommitRevisionLabel()

The post-commit revision label, or null.

This label is attached only to items that are changed during the commit. It is attached to the item revision that is current just after making the change.

The label will be created during the commit transaction, if the option is enabled.

Returns:

The post-commit revision label, or null if changes have not been committed or this label was not enabled when the changes were committed.

See Also:

Session.isPostCommitRevisionLabelEnabled

toString

public java.lang.String toString()

Returns the ChangePackage name.

Overrides:

toString in class java.lang.Object

Returns:

the ChangePackage name.

getChanges

public Change.WebCacheChange[] getChanges()

Gets the Change objects associated with this change package.

Returns:

ChangeCollection