org.eclipse.emf.emfstore.internal.client.model
Interface ProjectSpace

All Superinterfaces:

APIDelegate<ESLocalProjectImpl>, org.eclipse.emf.ecore.EObject, IdentifiableElement, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

ProjectSpaceBase, ProjectSpaceImpl

public interface ProjectSpace
extends IdentifiableElement, APIDelegate<ESLocalProjectImpl>

A representation of the model object ' Project Container'.

See Also:

ModelPackage.getProjectSpace()

Field Summary

static String

RUNNABLE_CONTEXT_ID ID of the runnable change context option.

Method Summary

FileIdentifier	addFile(File file) Adds a file to this project space.
FileIdentifier	addFile(File file, String fileIdentifier) Adds a file to this project space.
void	addOperations(List<? extends AbstractOperation> operations) Adds a list of operations to this project space.
void	addTag(PrimaryVersionSpec versionSpec, TagVersionSpec tag) Adds a tag to the specified version of this project.
CompositeOperationHandle	beginCompositeOperation() Begin a composite operation on the projectSpace.
PrimaryVersionSpec	commit(org.eclipse.core.runtime.IProgressMonitor monitor) Commits all pending changes of the project space.
PrimaryVersionSpec	commit(String logMessage, ESCommitCallback callback, org.eclipse.core.runtime.IProgressMonitor monitor) Commits all pending changes of the project space.
PrimaryVersionSpec	commitToBranch(BranchVersionSpec branch, String logMessage, ESCommitCallback callback, org.eclipse.core.runtime.IProgressMonitor monitor) This method allows to commit changes to a new branch.
void	delete(org.eclipse.core.runtime.IProgressMonitor monitor) Deletes the project space.
void	exportLocalChanges(File file) Export all local changes to a file.
void	exportLocalChanges(File file, org.eclipse.core.runtime.IProgressMonitor progressMonitor) Export all local changes to a file.
void	exportProject(File file) Export a project to the given file.
void	exportProject(File file, org.eclipse.core.runtime.IProgressMonitor progressMonitor) Export a project to the given file.
PrimaryVersionSpec	getBaseVersion() Returns the value of the 'Base Version' containment reference.
List<BranchInfo>	getBranches() Returns a list of branches of the current project.
org.eclipse.emf.common.util.EList<EMFStoreProperty>	getChangedSharedProperties() Returns the value of the 'Changed Shared Properties' reference list.
List<ChangePackage>	getChanges(VersionSpec sourceVersion, VersionSpec targetVersion)
FileDownloadStatus	getFile(FileIdentifier fileIdentifier) Gets a file with a specific identifier.
FileInformation	getFileInfo(FileIdentifier fileIdentifier) Gets the file information for a specific file identifier.
Date	getLastUpdated() Returns the value of the 'Last Updated' attribute.
ChangePackage	getLocalChangePackage() Returns the value of the 'Local Change Package' containment reference.
ChangePackage	getLocalChangePackage(boolean canonized) Gathers all local operations and canonizes them.
PrimaryVersionSpec	getMergedVersion() Returns the value of the 'Merged Version' containment reference.
org.eclipse.emf.common.util.EList<String>	getOldLogMessages() Returns the value of the 'Old Log Messages' attribute list.
OperationManager	getOperationManager() Get the OperationManager for this ProjectSpace.
List<AbstractOperation>	getOperations() Return the list of operations that have already been performed on the project space.
Project	getProject() Returns the value of the 'Project' containment reference.
String	getProjectDescription() Returns the value of the 'Project Description' attribute.
ProjectId	getProjectId() Returns the value of the 'Project Id' containment reference.
ProjectInfo	getProjectInfo() Get a project info for the project space.
String	getProjectName() Returns the value of the 'Project Name' attribute.
org.eclipse.emf.common.util.EList<EMFStoreProperty>	getProperties() Returns the value of the 'Properties' containment reference list.
PropertyManager	getPropertyManager() Get the PropertyManager for this ProjectSpace.
int	getResourceCount() Returns the value of the 'Resource Count' attribute.
org.eclipse.emf.ecore.resource.ResourceSet	getResourceSet() Returns the resource set of the ProjectSpace.
Usersession	getUsersession() Returns the value of the 'Usersession' reference.
org.eclipse.emf.common.util.EList<FileIdentifier>	getWaitingUploads() Returns the value of the 'Waiting Uploads' containment reference list.
Workspace	getWorkspace() Returns the value of the 'Workspace' container reference.
boolean	hasUnsavedChanges() Determine if the project space has unsaved changes to any element in the project.
void	importLocalChanges(String fileName) Import changes from a file.
void	init() Initialize the project space and its resources.
void	initResources(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Initialize the resources of the project space.
boolean	isDirty() Returns the value of the 'Dirty' attribute.
boolean	isShared() Whether this project space has been shared.
boolean	isTransient() Shows whether projectSpace is transient.
boolean	isUpdated() Determines whether the project is up to date, that is, whether the base revision and the head revision are equal.
void	makeTransient() Will make the projectSpace transient, it will not make its content or changes persistent.
void	mergeBranch(PrimaryVersionSpec branchSpec, ConflictResolver conflictResolver, org.eclipse.core.runtime.IProgressMonitor monitor) Allows to merge a version from another branch into the current project space.
ChangePackage	mergeResolvedConflicts(ChangeConflictSet conflictSet, List<ChangePackage> myChangePackages, List<ChangePackage> theirChangePackages) Merges the resolved conflict sets.
void	removeTag(PrimaryVersionSpec versionSpec, TagVersionSpec tag) Removes a tag to the specified version of this project.
org.eclipse.emf.ecore.EObject	resolve(ModelElementUrlFragment modelElementUrlFragment) Resolve the url to a model element.
PrimaryVersionSpec	resolveVersionSpec(VersionSpec versionSpec, org.eclipse.core.runtime.IProgressMonitor monitor) Resolve a version spec to a primary version spec.
void	revert() Revert all local changes in the project space.
void	save() Saves the project space.
void	setBaseVersion(PrimaryVersionSpec value) Sets the value of the 'Base Version' containment reference.
void	setDirty(boolean value) Sets the value of the 'Dirty ' attribute.
void	setLastUpdated(Date value) Sets the value of the 'Last Updated' attribute.
void	setLocalChangePackage(ChangePackage value) Sets the value of the ' Local Change Package' containment reference.
void	setMergedVersion(PrimaryVersionSpec value) Sets the value of the 'Merged Version' containment reference.
void	setProject(Project value) Sets the value of the 'Project' containment reference.
void	setProjectDescription(String value) Sets the value of the 'Project Description' attribute.
void	setProjectId(ProjectId value) Sets the value of the 'Project Id' containment reference.
void	setProjectName(String value) Sets the value of the 'Project Name' attribute.
void	setProperty(OrgUnitProperty property) Sets a new OrgUnitProperty for the current user.
void	setResourceCount(int value) Sets the value of the 'Resource Count' attribute.
void	setResourceSet(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Sets the resource set of the project space.
void	setRunnableContext(ESRunnableContext runnableContext) Provides a context in which a Runnable is executed.
void	setUsersession(Usersession value) Sets the value of the 'Usersession' reference.
void	setWorkspace(Workspace value) Sets the value of the 'Workspace' container reference.
ProjectInfo	shareProject(org.eclipse.core.runtime.IProgressMonitor monitor) Shares this project space.
ProjectInfo	shareProject(Usersession session, org.eclipse.core.runtime.IProgressMonitor monitor) Shares this project space.
void	transmitProperties() Transmit the OrgUnitproperties to the server.
void	undoLastOperation() Undo the last operation of the projectSpace.
void	undoLastOperations(int nrOperations) Undo the last operation n operations of the projectSpace.
PrimaryVersionSpec	update(org.eclipse.core.runtime.IProgressMonitor monitor) Update the project to the head version.
PrimaryVersionSpec	update(VersionSpec version) Update the project to the given version.
PrimaryVersionSpec	update(VersionSpec version, ESUpdateCallback callback, org.eclipse.core.runtime.IProgressMonitor progress) Update the workspace to the given revision.

Methods inherited from interface org.eclipse.emf.emfstore.internal.common.model.IdentifiableElement

getIdentifier, setIdentifier

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

Field Detail

RUNNABLE_CONTEXT_ID

static final String RUNNABLE_CONTEXT_ID

ID of the runnable change context option.

See Also:

Constant Field Values

Method Detail

setRunnableContext

void setRunnableContext(ESRunnableContext runnableContext)

Provides a context in which a Runnable is executed.

This may be used to provide a context while applying operations on a ESLocalProject.

Parameters:

runnableContext - the runnable context to be set

addFile

FileIdentifier addFile(File file)
                       throws FileTransferException

Adds a file to this project space. The file will be uploaded to the EMFStore upon a commit. As long as the file is not yet committed, it can be removed by first retrieving the FileInformation via getFileInfo(FileIdentifier) and then remove it via FileInformation.cancelPendingUpload().

Parameters:

file - to be added to the project space

Returns:

The file identifier the file was assigned to. This identifier can be used to retrieve the file later on

Throws:

FileTransferException - if any error occurs

addFile

FileIdentifier addFile(File file,
                       String fileIdentifier)
                       throws FileTransferException

Adds a file to this project space. The file will be uploaded to the EMFStore upon a commit. As long as the file is not yet committed, it can be removed by first retrieving the FileInformation via getFileInfo(FileIdentifier) and then remove it via FileInformation.cancelPendingUpload().

Parameters:

file - to be added to the project space

fileIdentifier - the file identifier to be used for the given file

Returns:

The file identifier the file was assigned to. This identifier can be used to retrieve the file later on

Throws:

FileTransferException - if any error occurs

addOperations

void addOperations(List<? extends AbstractOperation> operations)

Adds a list of operations to this project space.

Parameters:

operations - the list of operations to be added

addTag

void addTag(PrimaryVersionSpec versionSpec,
            TagVersionSpec tag)
            throws ESException

Adds a tag to the specified version of this project.

Parameters:

versionSpec - the versionSpec

tag - the tag

Throws:

ESException - if exception occurs on the server

beginCompositeOperation

CompositeOperationHandle beginCompositeOperation()

Begin a composite operation on the projectSpace.

Returns:

a handle to abort or complete the operation

commit

PrimaryVersionSpec commit(org.eclipse.core.runtime.IProgressMonitor monitor)
                          throws ESException

Commits all pending changes of the project space.

Parameters:

monitor - a progress monitor that may be used during the commit to indicate the progress

Returns:

the current version specification

Throws:

ESException - in case the commit went wrong

commit

PrimaryVersionSpec commit(String logMessage,
                          ESCommitCallback callback,
                          org.eclipse.core.runtime.IProgressMonitor monitor)
                          throws ESException

Commits all pending changes of the project space.

Parameters:

logMessage - a log message describing the changes to be committed

callback - an optional callback method to be performed while the commit is in progress, may be null

monitor - an optional progress monitor to be used while the commit is in progress, may be null

Returns:

the current version specification

Throws:

ESException - in case the commit went wrong

commitToBranch

PrimaryVersionSpec commitToBranch(BranchVersionSpec branch,
                                  String logMessage,
                                  ESCommitCallback callback,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                                  throws ESException

This method allows to commit changes to a new branch. It works very similar to commit(IProgressMonitor) with the addition of a Branch specifier. Once the branch is created use commit(IProgressMonitor) for further commits.

Parameters:

branch - branch specifier

logMessage - optional log message

callback - optional callback, passing an implementation is recommended

monitor - optional progress monitor

Returns:

the created version

Throws:

ESException - in case of an exception

mergeBranch

void mergeBranch(PrimaryVersionSpec branchSpec,
                 ConflictResolver conflictResolver,
                 org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws ESException

Allows to merge a version from another branch into the current project space.

Parameters:

branchSpec - the version which is supposed to be merged

conflictResolver - a ConflictResolver for conflict resolving

monitor - a progress monitor that may be used during the merge to indicate the progress

Throws:

ESException - in case of an exception

mergeResolvedConflicts

ChangePackage mergeResolvedConflicts(ChangeConflictSet conflictSet,
                                     List<ChangePackage> myChangePackages,
                                     List<ChangePackage> theirChangePackages)
                                     throws ChangeConflictException

Merges the resolved conflict sets.

Parameters:

conflictSet - a set containing the conflicts

myChangePackages - a list of local change packages

theirChangePackages - a list of containing the incoming change packages

Returns:

a merge change package

Throws:

ChangeConflictException - in case the conflicts can not be resolved

getBranches

List<BranchInfo> getBranches()
                             throws ESException

Returns a list of branches of the current project. Every call triggers a server call.

Returns:

list of BranchInfo

Throws:

ESException - in case of an exception

exportLocalChanges

void exportLocalChanges(File file)
                        throws IOException

Export all local changes to a file.

Parameters:

file - the file being exported to

Throws:

IOException - if writing to the given file fails

exportLocalChanges

void exportLocalChanges(File file,
                        org.eclipse.core.runtime.IProgressMonitor progressMonitor)
                        throws IOException

Export all local changes to a file.

Parameters:

file - the file being exported to

progressMonitor - the progress monitor that should be used while exporting

Throws:

IOException - if writing to the given file fails

exportProject

void exportProject(File file)
                   throws IOException

Export a project to the given file.

Parameters:

file - the file being exported to

Throws:

IOException - if writing to the given file fails

exportProject

void exportProject(File file,
                   org.eclipse.core.runtime.IProgressMonitor progressMonitor)
                   throws IOException

Export a project to the given file.

Parameters:

file - the file being exported to

progressMonitor - the progress monitor that should be used during the export

Throws:

IOException - if writing to the given file fails

getBaseVersion

PrimaryVersionSpec getBaseVersion()

Returns the value of the 'Base Version' containment reference.

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

Returns:

the value of the 'Base Version' containment reference.

See Also:

setBaseVersion(PrimaryVersionSpec), ModelPackage.getProjectSpace_BaseVersion()

getChangedSharedProperties

org.eclipse.emf.common.util.EList<EMFStoreProperty> getChangedSharedProperties()

Returns the value of the 'Changed Shared Properties' reference list. The list contents are of type EMFStoreProperty.

If the meaning of the 'Changed Shared Properties' map isn't clear, there really should be more of a description here...

Returns:

the value of the 'Changed Shared Properties' reference list.

See Also:

ModelPackage.getProjectSpace_ChangedSharedProperties()

getWorkspace

Workspace getWorkspace()

Returns the value of the 'Workspace' container reference. It is bidirectional and its opposite is ' Project Spaces'.

If the meaning of the 'Workspace' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Workspace' container reference.

See Also:

setWorkspace(Workspace), ModelPackage.getProjectSpace_Workspace(), Workspace.getProjectSpaces()

setWorkspace

void setWorkspace(Workspace value)

Sets the value of the 'Workspace' container reference.

Parameters:

value - the new value of the 'Workspace' container reference.

See Also:

getWorkspace()

getLocalChangePackage

ChangePackage getLocalChangePackage()

Returns the value of the 'Local Change Package' containment reference.

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

Returns:

the value of the 'Local Change Package' containment reference.

See Also:

setLocalChangePackage(ChangePackage), ModelPackage.getProjectSpace_LocalChangePackage()

setLocalChangePackage

void setLocalChangePackage(ChangePackage value)

Sets the value of the ' Local Change Package' containment reference.

Parameters:

value - the new value of the 'Local Change Package' containment reference.

See Also:

getLocalChangePackage()

getMergedVersion

PrimaryVersionSpec getMergedVersion()

Returns the value of the 'Merged Version' containment reference.

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

Returns:

the value of the 'Merged Version' containment reference.

See Also:

setMergedVersion(PrimaryVersionSpec), ModelPackage.getProjectSpace_MergedVersion()

setMergedVersion

void setMergedVersion(PrimaryVersionSpec value)

Sets the value of the 'Merged Version' containment reference.

Parameters:

value - the new value of the 'Merged Version' containment reference.

See Also:

getMergedVersion()

getChanges

List<ChangePackage> getChanges(VersionSpec sourceVersion,
                               VersionSpec targetVersion)
                               throws ESException

Parameters:

sourceVersion - the source version spec

targetVersion - the target version spec

Returns:

a list of the change packages between two PrimarySpecVersions.

Throws:

ESException - if any error in the EmfStore occurs

getFile

FileDownloadStatus getFile(FileIdentifier fileIdentifier)
                           throws FileTransferException

Gets a file with a specific identifier. If the file is not cached locally, it is tried to download the file if a connection to the sever exists. If the file cannot be found locally and not on the server (or the server isn't reachable), a FileTransferException is thrown. Such an exception is also thrown if other errors occur while trying to download the file. The method returns not the file itself, because it does not block in case of downloading the file. Instead, it returns a status object which can be queried for the status of the download. Once the download is finished ( status.isFinished() ), the file can be retrieved from this status object by calling status.getTransferredFile().

Parameters:

fileIdentifier - file identifier string.

Returns:

a status object that can be used to retrieve various information about the file.

Throws:

FileTransferException - if any error occurs retrieving the files

getFileInfo

FileInformation getFileInfo(FileIdentifier fileIdentifier)

Gets the file information for a specific file identifier. This file information can be used to access further details of a file (if it exists, is cached, is a pending upload). It can also be used to alter the file in limited ways (like removing a pending upload). The FileInformation class is basically a facade to keep the interface in the project space small (only getFileInfo) while still providing a rich interface for files.

Parameters:

fileIdentifier - the file identifier for which to get the information

Returns:

the information for that identifier.

getLastUpdated

Date getLastUpdated()

Returns the value of the 'Last Updated' attribute.

If the meaning of the 'Last Updated' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Last Updated' attribute.

See Also:

setLastUpdated(Date), ModelPackage.getProjectSpace_LastUpdated()

getLocalChangePackage

ChangePackage getLocalChangePackage(boolean canonized)

Gathers all local operations and canonizes them.

Parameters:

canonized - true if the operations should be canonized

Returns:

the list of operations

getOldLogMessages

org.eclipse.emf.common.util.EList<String> getOldLogMessages()

Returns the value of the 'Old Log Messages' attribute list. The list contents are of type String.

If the meaning of the 'Old Log Messages' attribute list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Old Log Messages' attribute list.

See Also:

ModelPackage.getProjectSpace_OldLogMessages()

getOperationManager

OperationManager getOperationManager()

Get the OperationManager for this ProjectSpace.

Returns:

the operation manager

getOperations

List<AbstractOperation> getOperations()

Return the list of operations that have already been performed on the project space.

Returns:

a list of operations

getProject

Project getProject()

Returns the value of the 'Project' containment reference.

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

Returns:

the value of the 'Project' containment reference.

See Also:

setProject(Project), ModelPackage.getProjectSpace_Project()

getProjectDescription

String getProjectDescription()

Returns the value of the 'Project Description' attribute.

If the meaning of the 'Project Description' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Project Description' attribute.

See Also:

setProjectDescription(String), ModelPackage.getProjectSpace_ProjectDescription()

getProjectId

ProjectId getProjectId()

Returns the value of the 'Project Id' containment reference.

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

Returns:

the value of the 'Project Id' containment reference.

See Also:

setProjectId(ProjectId), ModelPackage.getProjectSpace_ProjectId()

getProjectInfo

ProjectInfo getProjectInfo()

Get a project info for the project space.

Returns:

a project info

getProjectName

String getProjectName()

Returns the value of the 'Project Name' attribute.

If the meaning of the 'Project Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Project Name' attribute.

See Also:

setProjectName(String), ModelPackage.getProjectSpace_ProjectName()

getProperties

org.eclipse.emf.common.util.EList<EMFStoreProperty> getProperties()

Returns the value of the 'Properties' containment reference list. The list contents are of type EMFStoreProperty.

If the meaning of the 'Properties' map isn't clear, there really should be more of a description here...

Returns:

the value of the 'Properties' containment reference list.

See Also:

ModelPackage.getProjectSpace_Properties()

getPropertyManager

PropertyManager getPropertyManager()

Get the PropertyManager for this ProjectSpace.

Returns:

the property manager

getUsersession

Usersession getUsersession()

Returns the value of the 'Usersession' reference.

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

Returns:

the value of the 'Usersession' reference.

See Also:

setUsersession(Usersession), ModelPackage.getProjectSpace_Usersession()

getWaitingUploads

org.eclipse.emf.common.util.EList<FileIdentifier> getWaitingUploads()

Returns the value of the 'Waiting Uploads' containment reference list. The list contents are of type FileIdentifier.

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

Returns:

the value of the 'Waiting Uploads' containment reference list.

See Also:

ModelPackage.getProjectSpace_WaitingUploads()

importLocalChanges

void importLocalChanges(String fileName)
                        throws IOException

Import changes from a file.

Parameters:

fileName - the file name to import from

Throws:

IOException - if file access fails

init

void init()

Initialize the project space and its resources.

initResources

void initResources(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Initialize the resources of the project space.

Parameters:

resourceSet - the resource set the project space should use

delete

void delete(org.eclipse.core.runtime.IProgressMonitor monitor)
            throws IOException

Deletes the project space.

Parameters:

monitor - a progress monitor that may be used during the delete to indicate the progress

Throws:

IOException - in case the project space could not be deleted

getResourceSet

org.eclipse.emf.ecore.resource.ResourceSet getResourceSet()

Returns the resource set of the ProjectSpace.

Returns:

resource set of the ProjectSpace

setResourceSet

void setResourceSet(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Sets the resource set of the project space.

Parameters:

resourceSet - the resource set to be used by this project space

isDirty

boolean isDirty()

Returns the value of the 'Dirty' attribute.

If the meaning of the 'Dirty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Dirty' attribute.

See Also:

setDirty(boolean), ModelPackage.getProjectSpace_Dirty()

isTransient

boolean isTransient()

Shows whether projectSpace is transient.

Returns:

true, if transient.

isUpdated

boolean isUpdated()
                  throws ESException

Determines whether the project is up to date, that is, whether the base revision and the head revision are equal.

Returns:

true, if the project is up to date, false otherwise

Throws:

ESException - if the head revision can not be resolved

makeTransient

void makeTransient()

Will make the projectSpace transient, it will not make its content or changes persistent. Can only be called before the resources or the project space have been initialized.

removeTag

void removeTag(PrimaryVersionSpec versionSpec,
               TagVersionSpec tag)
               throws ESException

Removes a tag to the specified version of this project.

Parameters:

versionSpec - the versionSpec

tag - the tag

Throws:

ESException - if exception occurs on the server

resolve

org.eclipse.emf.ecore.EObject resolve(ModelElementUrlFragment modelElementUrlFragment)
                                      throws MEUrlResolutionException

Resolve the url to a model element.

Parameters:

modelElementUrlFragment - the url

Returns:

the model element

Throws:

MEUrlResolutionException - if model element does not exist in project.

resolveVersionSpec

PrimaryVersionSpec resolveVersionSpec(VersionSpec versionSpec,
                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                      throws ESException

Resolve a version spec to a primary version spec.

Parameters:

versionSpec - the spec to resolve

monitor - a progress monitor that may be used during resolving the version to indicate the progress

Returns:

the primary version specifier

Throws:

ESException - if resolving fails

revert

void revert()

Revert all local changes in the project space. Returns the state of the project to that of the project space base version.

setBaseVersion

void setBaseVersion(PrimaryVersionSpec value)

Sets the value of the 'Base Version' containment reference.

Parameters:

value - the new value of the 'Base Version' containment reference.

See Also:

getBaseVersion()

getResourceCount

int getResourceCount()

Returns the value of the 'Resource Count' attribute.

If the meaning of the 'Resource Count' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Resource Count' attribute.

See Also:

setResourceCount(int), ModelPackage.getProjectSpace_ResourceCount()

setResourceCount

void setResourceCount(int value)

Sets the value of the 'Resource Count' attribute.

Parameters:

value - the new value of the 'Resource Count' attribute.

See Also:

getResourceCount()

setDirty

void setDirty(boolean value)

Sets the value of the 'Dirty ' attribute.

Parameters:

value - the new value of the 'Dirty' attribute.

See Also:

isDirty()

setLastUpdated

void setLastUpdated(Date value)

Sets the value of the 'Last Updated' attribute.

Parameters:

value - the new value of the 'Last Updated' attribute.

See Also:

getLastUpdated()

setProject

void setProject(Project value)

Sets the value of the 'Project' containment reference.

Parameters:

value - the new value of the 'Project' containment reference.

See Also:

getProject()

setProjectDescription

void setProjectDescription(String value)

Sets the value of the 'Project Description' attribute.

Parameters:

value - the new value of the 'Project Description' attribute.

See Also:

getProjectDescription()

setProjectId

void setProjectId(ProjectId value)

Sets the value of the 'Project Id' containment reference.

Parameters:

value - the new value of the 'Project Id' containment reference.

See Also:

getProjectId()

setProjectName

void setProjectName(String value)

Sets the value of the 'Project Name' attribute.

Parameters:

value - the new value of the 'Project Name' attribute.

See Also:

getProjectName()

setProperty

void setProperty(OrgUnitProperty property)

Sets a new OrgUnitProperty for the current user.

Parameters:

property - the new property

setUsersession

void setUsersession(Usersession value)

Sets the value of the 'Usersession' reference.

Parameters:

value - the new value of the 'Usersession' reference.

See Also:

getUsersession()

shareProject

ProjectInfo shareProject(org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws ESException

Shares this project space.

Returns:

the project info of the created project

Throws:

ESException - if an error occurs during the sharing of the project

shareProject

ProjectInfo shareProject(Usersession session,
                         org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws ESException

Shares this project space.

Parameters:

session - the Usersession that should be used for sharing the project

monitor - an instance of an IProgressMonitor

Returns:

the project info of the remote project

Throws:

ESException - if an error occurs during the sharing of the project

transmitProperties

void transmitProperties()

Transmit the OrgUnitproperties to the server.

undoLastOperation

void undoLastOperation()

Undo the last operation of the projectSpace.

undoLastOperations

void undoLastOperations(int nrOperations)

Undo the last operation n operations of the projectSpace.

Parameters:

nrOperations - the number of operations to be undone

update

PrimaryVersionSpec update(org.eclipse.core.runtime.IProgressMonitor monitor)
                          throws ESException

Update the project to the head version.

Parameters:

monitor - a progress monitor that may be used during update to indicate progress

Returns:

the new base version

Throws:

ESException - if update fails

update

PrimaryVersionSpec update(VersionSpec version)
                          throws ESException

Update the project to the given version.

Parameters:

version - the version to update to

Returns:

the new base version

Throws:

ESException - if update fails

update

PrimaryVersionSpec update(VersionSpec version,
                          ESUpdateCallback callback,
                          org.eclipse.core.runtime.IProgressMonitor progress)
                          throws ESException

Update the workspace to the given revision.

Parameters:

version - the VersionSpec to update to

callback - the ESUpdateCallback that will be called when the update has been performed

progress - an IProgressMonitor instance

Returns:

the current version specifier

Throws:

ESException - in case the update went wrong

hasUnsavedChanges

boolean hasUnsavedChanges()

Determine if the project space has unsaved changes to any element in the project.

Returns:

true if there is unsaved changes.

save

void save()

Saves the project space.

isShared

boolean isShared()

Whether this project space has been shared.

Returns:

true, if the project space has been shared, false otherwise