org.eclipse.emf.emfstore.server.model
Interface ESHistoryInfo

All Known Implementing Classes:

ESHistoryInfoImpl

public interface ESHistoryInfo

When querying the history API successfully, the result is a set of ESHistoryInfo. Each ESHistoryInfo contains pointers to versions, in form of PrimaryVersionIdentier, as well as possible tags, the log message for the given version and optionally the changes for this version.

Author:

emueller, wesendon

Method Summary

ESChangePackage	getChangePackage() Returns the ESChangePackage containing the changes associated with this history.
ESLogMessage	getLogMessage() Returns the ESLogMessage that was specified when a commit succeeded.
List<ESPrimaryVersionSpec>	getMergedFromSpecs() Returns an optional list of ESPrimaryVersionSpecs that identifies the versions this version was merged from.
List<ESPrimaryVersionSpec>	getMergedToSpecs() Returns an optional list of ESPrimaryVersionSpecs that identifies the versions this version was merged from.
List<ESPrimaryVersionSpec>	getNextSpecs() Returns a list of the ESPrimaryVersionSpecs that followed this version.
ESPrimaryVersionSpec	getPreviousSpec() Returns the ESPrimaryVersionSpec of the previous version.
ESPrimaryVersionSpec	getPrimarySpec() Returns the version the history information is associated with.
List<ESTagVersionSpec>	getTagSpecs() Returns the tag specifiers associated with this history.

Method Detail

getPrimarySpec

ESPrimaryVersionSpec getPrimarySpec()

Returns the version the history information is associated with.

Returns:

the ESPrimaryVersionSpec of the history information

getNextSpecs

List<ESPrimaryVersionSpec> getNextSpecs()

Returns a list of the ESPrimaryVersionSpecs that followed this version.

Returns:

a list containing the next ESPrimaryVersionSpecs

getPreviousSpec

ESPrimaryVersionSpec getPreviousSpec()

Returns the ESPrimaryVersionSpec of the previous version.

Returns:

the previous version

getMergedFromSpecs

List<ESPrimaryVersionSpec> getMergedFromSpecs()

Returns an optional list of ESPrimaryVersionSpecs that identifies the versions this version was merged from.

Returns:

an optional list of branch versions this version was merged from

getMergedToSpecs

List<ESPrimaryVersionSpec> getMergedToSpecs()

Returns an optional list of ESPrimaryVersionSpecs that identifies the versions this version was merged from.

Returns:

an optional list of branch versions this version was merged from

getLogMessage

ESLogMessage getLogMessage()

Returns the ESLogMessage that was specified when a commit succeeded.

Returns:

the log message that is associated with this history information

getTagSpecs

List<ESTagVersionSpec> getTagSpecs()

Returns the tag specifiers associated with this history.

Returns:

a list of tag specifiers

getChangePackage

ESChangePackage getChangePackage()

Returns the ESChangePackage containing the changes associated with this history.

Returns:

the change package containing the changes.