wt.vc
Class VersionControlServiceEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.vc.VersionControlServiceEvent

All Implemented Interfaces:

Serializable, wt.events.summary.SummarizedEvent

public class VersionControlServiceEvent
extends KeyedEvent
implements Serializable

Provides a service specific event extended from KeyedEvent used in conjunction with the standard implementation of the server-side functionality as defined by the VersionControlService interface. This event could also be used by a custom implementation of the VersionControlService.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	NEW_ITERATION A constant that defines an event marking the occurrance of the creation of an iteration, not version.
static String	NEW_VERSION A constant that defines an event marking the occurrance of the creation of a version, that is the very first iteration created in its iteration line (i.e., branch).
static String	POST_MERGE A constant that defines an event marking the occurrance of a merge of one version into another.
static String	POST_ROLLBACK A constant that defines an event marking the occurrance of the rollback (unsuperseding) of an iteration with another one.
static String	POST_ROLLUP A constant that defines an event marking the occurrance of the rollup of an iteration(s) with another one.
static String	POST_SUPERSEDE A constant that defines an event marking the occurrance of the superseding of the "latest" iteration with another "latest" one.
static String	PRE_MERGE A constant that defines an event marking the occurrance of a merge of one version into another.
static String	PRE_NEW_VERSION A constant that defines an event marking the occurrance of the creation of a new version, that is the very first iteration created in its iteration line (i.e., branch).
static String	PRE_ROLLBACK A constant that defines an event marking the occurrance of the rollback (unsuperseding) of an iteration that is about to commense.
static String	PRE_ROLLUP A constant that defines an event marking the occurrance of the rollup of an iteration(s) that is about to commense.
static String	PRE_SUPERSEDE A constant that defines an event marking the occurrance of the replacement of a new iteration that is about to commense.

Method Summary

Iterated	getAppendedIteration() Gets the iteration [target] of the event.
WTValuedMap	getDestinationsToMergedIterationMap() For PRE_MERGE and POST_MERGE event types (only), this method returns a map from merge destination objects to newly created "merged" objects.
Iterated	getIteration() Gets the iteration [target] of the event.
Versioned	getMergeDestinationIteration() For single-object PRE_MERGE and POST_MERGE events (only), this method returns the iteration which is the destination of the merge operation.
WTCollection	getMergeDestinationIterations() For PRE_MERGE and POST_MERGE event types (only), this method returns a collection of all merge destination objects.
Versioned	getMergedIteration() For single-object PRE_MERGE and POST_MERGE events (only), this method returns the iteration which is the result of the merge operation.
WTSet	getMergedIterations() For PRE_MERGE and POST_MERGE event types (only), this method returns a set of all the newly created "merged" objects.
WTValuedMap	getMergedIterationToDestinationsMap() For PRE_MERGE and POST_MERGE event types (only), this method returns a map from newly created "merged" objects to merge destination objects.
Versioned	getMergeSourceIteration() For single-object PRE_MERGE and POST_MERGE events (only), this method returns the iteration which is the source of the merge operation.
WTSet	getMergeSourceIterations() For PRE_MERGE and POST_MERGE event types (only), this method returns a set of all merge source objects.
WTValuedMap	getMergeSourceToDestinationsMap() For PRE_MERGE and POST_MERGE event types (only), this method returns a map from merge source to merge destination objects.
WTValuedMap	getMergeSourceToMergedIterationsMap() For PRE_MERGE and POST_MERGE event types (only), this method returns a map from merge source to newly created "merged" objects.
Vector	getRolledBackIterations() Gets all of the iterations that have been rolled back to the one becoming the latest iteration.
Vector	getRolledUpIterations() Gets all of the iterations that have been rolled up from the one becoming the very first iteration.
Iterated	getSupersededIteration() Gets the old superseded iteration [target] of the event.
Iterated	getSupersedingIteration() Gets the new superseding iteration [target] of the event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NEW_ITERATION

public static final String NEW_ITERATION

A constant that defines an event marking the occurrance of the creation of an iteration, not version. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

NEW_VERSION

public static final String NEW_VERSION

A constant that defines an event marking the occurrance of the creation of a version, that is the very first iteration created in its iteration line (i.e., branch). Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

PRE_SUPERSEDE

public static final String PRE_SUPERSEDE

A constant that defines an event marking the occurrance of the replacement of a new iteration that is about to commense. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

POST_SUPERSEDE

public static final String POST_SUPERSEDE

A constant that defines an event marking the occurrance of the superseding of the "latest" iteration with another "latest" one. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

PRE_ROLLBACK

public static final String PRE_ROLLBACK

A constant that defines an event marking the occurrance of the rollback (unsuperseding) of an iteration that is about to commense. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

POST_ROLLBACK

public static final String POST_ROLLBACK

A constant that defines an event marking the occurrance of the rollback (unsuperseding) of an iteration with another one. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

PRE_ROLLUP

public static final String PRE_ROLLUP

A constant that defines an event marking the occurrance of the rollup of an iteration(s) that is about to commense. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

POST_ROLLUP

public static final String POST_ROLLUP

A constant that defines an event marking the occurrance of the rollup of an iteration(s) with another one. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

PRE_MERGE

public static final String PRE_MERGE

A constant that defines an event marking the occurrance of a merge of one version into another. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto. They also have an opportunity to modify or amend the newly formed "merge" iterations prior to their initial persistence in the database.

Supported API: true

See Also:

Constant Field Values

POST_MERGE

public static final String POST_MERGE

A constant that defines an event marking the occurrance of a merge of one version into another. Listener's of this event can stipulate that post conditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

PRE_NEW_VERSION

public static final String PRE_NEW_VERSION

A constant that defines an event marking the occurrance of the creation of a new version, that is the very first iteration created in its iteration line (i.e., branch). Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

Method Detail

getSupersededIteration

public Iterated getSupersededIteration()

Gets the old superseded iteration [target] of the event. This is only applicable to when an iteration is about to be superseded.

Supported API: true

Returns:

Iterated

See Also:

PRE_SUPERSEDE

getSupersedingIteration

public Iterated getSupersedingIteration()

Gets the new superseding iteration [target] of the event. This is only applicable to when an iteration is about to be superseded.

Supported API: true

Returns:

Iterated

See Also:

PRE_SUPERSEDE

getRolledBackIterations

public Vector getRolledBackIterations()

Gets all of the iterations that have been rolled back to the one becoming the latest iteration. This is only applicable to when an iteration is about to be rolled back. The order of iterations returned is from most recent to least.

Supported API: true

Returns:

Vector

See Also:

PRE_ROLLBACK

getRolledUpIterations

public Vector getRolledUpIterations()

Gets all of the iterations that have been rolled up from the one becoming the very first iteration. This is only applicable to when an iteration is about to be rolled back. The order of iterations returned is from most recent to least.

Supported API: true

Returns:

Vector

See Also:

PRE_ROLLUP

getIteration

public Iterated getIteration()

Gets the iteration [target] of the event. This is only applicable to when a new "latest" iteration has been created, or when an iteration has become superseded, or when an iteration has become rolled back.

Supported API: true

Returns:

Iterated

See Also:

NEW_VERSION, POST_SUPERSEDE, POST_ROLLBACK

getAppendedIteration

public Iterated getAppendedIteration()

Gets the iteration [target] of the event. This is only applicable to when a new "latest" iteration has been appended

Supported API: true

Returns:

Iterated

See Also:

getIteration()

getMergeSourceIteration

public Versioned getMergeSourceIteration()

For single-object PRE_MERGE and POST_MERGE events (only), this method returns the iteration which is the source of the merge operation.

Supported API: true

Returns:

Versioned

getMergeDestinationIteration

public Versioned getMergeDestinationIteration()

For single-object PRE_MERGE and POST_MERGE events (only), this method returns the iteration which is the destination of the merge operation.

Supported API: true

Returns:

Versioned

getMergedIteration

public Versioned getMergedIteration()

For single-object PRE_MERGE and POST_MERGE events (only), this method returns the iteration which is the result of the merge operation.

Supported API: true

Returns:

Versioned

getMergeSourceToDestinationsMap

public WTValuedMap getMergeSourceToDestinationsMap()

For PRE_MERGE and POST_MERGE event types (only), this method returns a map from merge source to merge destination objects.

Supported API: true

Returns:

WTValuedMap

getMergeSourceToMergedIterationsMap

public WTValuedMap getMergeSourceToMergedIterationsMap()

For PRE_MERGE and POST_MERGE event types (only), this method returns a map from merge source to newly created "merged" objects.

Supported API: true

Returns:

WTValuedMap

getMergedIterationToDestinationsMap

public WTValuedMap getMergedIterationToDestinationsMap()

For PRE_MERGE and POST_MERGE event types (only), this method returns a map from newly created "merged" objects to merge destination objects.

Supported API: true

Returns:

WTValuedMap

getDestinationsToMergedIterationMap

public WTValuedMap getDestinationsToMergedIterationMap()

For PRE_MERGE and POST_MERGE event types (only), this method returns a map from merge destination objects to newly created "merged" objects.

Supported API: true

Returns:

WTValuedMap

getMergeSourceIterations

public WTSet getMergeSourceIterations()

For PRE_MERGE and POST_MERGE event types (only), this method returns a set of all merge source objects.

Supported API: true

Returns:

WTSet

getMergeDestinationIterations

public WTCollection getMergeDestinationIterations()

For PRE_MERGE and POST_MERGE event types (only), this method returns a collection of all merge destination objects.

Supported API: true

Returns:

WTCollection

getMergedIterations

public WTSet getMergedIterations()

For PRE_MERGE and POST_MERGE event types (only), this method returns a set of all the newly created "merged" objects.

Supported API: true

Returns:

WTSet