org.eclipse.emf.emfstore.internal.server.model.versioning
Interface ChangePackage

All Superinterfaces:
APIDelegate<ESChangePackage>, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
ChangePackageImpl

public interface ChangePackage
extends org.eclipse.emf.ecore.EObject, APIDelegate<ESChangePackage>

A representation of the model object ' Change Package'.

See Also:
VersioningPackage.getChangePackage()

Method Summary
 void apply(Project project)
          Apply all operations in the change package to the given project.
 void apply(Project project, boolean force)
          Apply all operations in the change package to the given project.
 void cannonize()
          Remove all operations from the change package that are masked by later operations in the same package.
 Set<ModelElementId> getAllInvolvedModelElements()
          Returns all model elements that are involved in this change package.
 List<AbstractOperation> getCopyOfOperations()
          Retrieve a copy of all operations in the change package.
 org.eclipse.emf.common.util.EList<Event> getEvents()
          Returns the value of the 'Events' containment reference list.
 List<AbstractOperation> getLeafOperations()
          Get all leaf operations of a change package, decomposing all composite operations.
 LogMessage getLogMessage()
          Returns the value of the 'Log Message' containment reference.
 org.eclipse.emf.common.util.EList<AbstractOperation> getOperations()
          Returns the value of the 'Operations' containment reference list.
 int getSize()
          Counts the number of Leaf Operations within this change package.
 List<AbstractOperation> getTouchingOperations(ModelElementId modelElementId)
          Get all operations of a change package, that are touching the given model element id
 org.eclipse.emf.common.util.EList<VersionProperty> getVersionProperties()
          Returns the value of the 'Version Properties' containment reference list.
 ChangePackage reverse()
          Reverse the change package.
 void setLogMessage(LogMessage value)
          Sets the value of the ' Log Message' containment reference.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.emf.emfstore.internal.common.api.APIDelegate
createAPI, toAPI
 

Method Detail

getOperations

org.eclipse.emf.common.util.EList<AbstractOperation> getOperations()
Returns the value of the 'Operations' containment reference list. The list contents are of type AbstractOperation.

Returns:
the value of the 'Operations' containment reference list.
See Also:
VersioningPackage.getChangePackage_Operations()

getEvents

org.eclipse.emf.common.util.EList<Event> getEvents()
Returns the value of the 'Events' containment reference list. The list contents are of type Event.

If the meaning of the 'Events' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Events' containment reference list.
See Also:
VersioningPackage.getChangePackage_Events()

getLogMessage

LogMessage getLogMessage()
Returns the value of the 'Log Message' containment reference.

If the meaning of the 'Log Message' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Log Message' containment reference.
See Also:
setLogMessage(LogMessage), VersioningPackage.getChangePackage_LogMessage()

setLogMessage

void setLogMessage(LogMessage value)
Sets the value of the ' Log Message' containment reference.

Parameters:
value - the new value of the 'Log Message' containment reference.
See Also:
getLogMessage()

getVersionProperties

org.eclipse.emf.common.util.EList<VersionProperty> getVersionProperties()
Returns the value of the 'Version Properties' containment reference list. The list contents are of type VersionProperty.

If the meaning of the 'Version Properties' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Version Properties' containment reference list.
See Also:
VersioningPackage.getChangePackage_VersionProperties()

apply

void apply(Project project)
Apply all operations in the change package to the given project.

Parameters:
project - the project

apply

void apply(Project project,
           boolean force)
Apply all operations in the change package to the given project. Additional you can force the operations to be applied with illegal operations being ignored.

Parameters:
project - the project
force - if true, illegal Operations won't stop the other to be applied

cannonize

void cannonize()
Remove all operations from the change package that are masked by later operations in the same package.


reverse

ChangePackage reverse()
Reverse the change package. Applying a change package and then its reversed change package does not change a project in effect.

Returns:
the reverse change package

getCopyOfOperations

List<AbstractOperation> getCopyOfOperations()
Retrieve a copy of all operations in the change package.


getLeafOperations

List<AbstractOperation> getLeafOperations()
Get all leaf operations of a change package, decomposing all composite operations. The effect of the leaf operations on a project is the same as the effect of the root operations of this change package.

Returns:
a list of leaf operations.

getAllInvolvedModelElements

Set<ModelElementId> getAllInvolvedModelElements()
Returns all model elements that are involved in this change package.

Returns:
a set of model element ids

getTouchingOperations

List<AbstractOperation> getTouchingOperations(ModelElementId modelElementId)
Get all operations of a change package, that are touching the given model element id

Returns:
a list of leaf operations.

getSize

int getSize()
Counts the number of Leaf Operations within this change package. The method will recursivly go thru all composite operations

Returns:
the number of Leaf Operations


Copyright © 2015. All Rights Reserved.