|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ESLocalProject
Represents a project in the local workspace that was checked out from a server or created locally.
Method Summary | |
---|---|
void |
addToWorkspace(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Adds this project to the workspace. |
ESPrimaryVersionSpec |
commit(org.eclipse.core.runtime.IProgressMonitor monitor)
Commits any local changes. |
ESPrimaryVersionSpec |
commit(String logMessage,
ESCommitCallback callback,
org.eclipse.core.runtime.IProgressMonitor monitor)
Commits any local changes. |
ESPrimaryVersionSpec |
commitToBranch(ESBranchVersionSpec branch,
String logMessage,
ESCommitCallback callback,
org.eclipse.core.runtime.IProgressMonitor monitor)
Commits any local changes to a branch. |
ESPrimaryVersionSpec |
getBaseVersion()
Returns the base version of the project. |
Date |
getLastUpdated()
Returns the Date when the project was updated the last time. |
ESLocalProjectId |
getLocalProjectId()
Returns a locally unique ID for the project. |
List<String> |
getRecentLogMessages()
Returns a list with copies of the most recent log messages. |
ESRemoteProject |
getRemoteProject()
Returns the ESRemoteProject on a server this local project is associated with. |
ESUsersession |
getUsersession()
Returns the ESUsersession associated with this project, if any. |
boolean |
hasUncommitedChanges()
Determines whether the project has uncommitted changes. |
boolean |
hasUnsavedChanges()
Determines whether the project has unsaved changes. |
boolean |
isShared()
Whether this project has been shared. |
boolean |
isUpdated()
Determines whether the project is up to date, that is, whether the base revision and the head revision are equal. |
void |
revert()
Revert all local changes in the project space. |
void |
save()
Saves the project space. |
ESRemoteProject |
shareProject(ESUsersession session,
org.eclipse.core.runtime.IProgressMonitor monitor)
Shares this project. |
void |
shareProject(org.eclipse.core.runtime.IProgressMonitor monitor)
Shares this project. |
void |
undoLastOperation()
Undoes the last operation of the project. |
void |
undoLastOperations(int operations)
Undo the last operation n operations of the project. |
ESPrimaryVersionSpec |
update(ESVersionSpec version,
ESUpdateCallback callback,
org.eclipse.core.runtime.IProgressMonitor monitor)
Updates the project to the given version from the server. |
ESPrimaryVersionSpec |
update(org.eclipse.core.runtime.IProgressMonitor monitor)
Updates the project to the head version from the server. |
Methods inherited from interface org.eclipse.emf.emfstore.client.ESProject |
---|
addTag, delete, getBranches, getGlobalProjectId, getHistoryInfos, getProjectName, removeTag, resolveVersionSpec |
Methods inherited from interface org.eclipse.emf.emfstore.common.model.ESObjectContainer |
---|
contains, contains, getAllModelElements, getAllModelElementsByClass, getAllModelElementsByClass, getModelElement, getModelElementId, getModelElements |
Method Detail |
---|
ESPrimaryVersionSpec commit(org.eclipse.core.runtime.IProgressMonitor monitor) throws ESException
Commits any local changes.
NOTE: The commit will be executed in headless mode, so no callback can be specified. If clients would like
to influence the commit behavior, they should use commit(String, ESCommitCallback, IProgressMonitor)
.
This method throws a ESProjectNotSharedException
runtime
exception if the project hasn't been shared yet
monitor
- a progress monitor to track the progress of the commit
ESException
- in case any error occurs during commitESPrimaryVersionSpec commit(String logMessage, ESCommitCallback callback, org.eclipse.core.runtime.IProgressMonitor monitor) throws ESUpdateRequiredException, ESException
Commits any local changes.
NOTE: If no callback is specified the return value will be used to indicate whether the commit was successful or not. This enables the the headless execution of the commit.
This method throws a ESProjectNotSharedException
runtime
exception if the project hasn't been shared yet
logMessage
- a message describing the changes being committedcallback
- an optional ESCommitCallback
monitor
- an IProgressMonitor
instance that is used to track the progress of the commit
ESUpdateRequiredException
- in case the local working copy is outdated and an update is required
ESException
- in case any other error occurs during commitESPrimaryVersionSpec commitToBranch(ESBranchVersionSpec branch, String logMessage, ESCommitCallback callback, org.eclipse.core.runtime.IProgressMonitor monitor) throws InvalidVersionSpecException, ESUpdateRequiredException, ESException
Commits any local changes to a branch.
NOTE: If no callback is specified the return value will be used to indicate whether the commit was successful or not. This enables the the headless execution of the commit.
This method throws a ESProjectNotSharedException
runtime
exception if the project hasn't been shared yet
branch
- the ESBranchVersionSpec
indicating the branch to commit tologMessage
- a message describing the changes being committedcallback
- a optional ESCommitCallback
monitor
- an IProgressMonitor
instance that is used to track the progress of the commit
InvalidVersionSpecException
- in case the given ESBranchVersionSpec
could not be resolved
ESUpdateRequiredException
- in case the local working copy is outdated
ESException
- in case any other error occurs during commitESPrimaryVersionSpec update(org.eclipse.core.runtime.IProgressMonitor monitor) throws ChangeConflictException, ESException
Updates the project to the head version from the server.
This method throws a ESProjectNotSharedException
runtime
exception if the project hasn't been shared yet
monitor
- a progress monitor to track progress
ChangeConflictException
- in case a conflict is detected on update
ESException
- in case update fails for any other reasonESPrimaryVersionSpec update(ESVersionSpec version, ESUpdateCallback callback, org.eclipse.core.runtime.IProgressMonitor monitor) throws ChangeConflictException, ESException
Updates the project to the given version from the server.
This method throws a ESProjectNotSharedException
runtime
exception if the project hasn't been shared yet
version
- the ESVersionSpec
to update tocallback
- the ESUpdateCallback
that will be called while the update is performingmonitor
- an IProgressMonitor
instance that is used to track the progress of the update
ChangeConflictException
- in case a conflict is detected on update
ESException
- in case update fails for any other reasonvoid addToWorkspace(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
progressMonitor
- a IProgressMonitor
to track the progress while
adding the project to the workspacevoid shareProject(org.eclipse.core.runtime.IProgressMonitor monitor) throws ESException
Shares this project.
The ESUsersession
used to share the project will be injected by the framework.
monitor
- an IProgressMonitor
instance that is used to indicate progress while sharing the project
ESException
- in case an error occurs while sharing the projectESRemoteProject shareProject(ESUsersession session, org.eclipse.core.runtime.IProgressMonitor monitor) throws ESException
session
- the ESUsersession
that should be used for sharing the projectmonitor
- an IProgressMonitor
instance that is used to indicate progress while sharing the project
ESException
- in case an error occurs while sharing the projectboolean isShared()
true
, if the project space has been shared, false
otherwiseESUsersession getUsersession()
ESUsersession
associated with this project, if any.
null
, if no such session is availableESPrimaryVersionSpec getBaseVersion()
Date getLastUpdated()
Date
when the project was updated the last time.
List<String> getRecentLogMessages()
void undoLastOperation()
void undoLastOperations(int operations)
operations
- the number of operations to be undoneboolean isUpdated() throws ESException
true
, if the project is up to date, false
otherwise
ESException
- if the head revision can not be resolvedvoid revert()
void save()
boolean hasUnsavedChanges()
true
, if there are unsaved changes, false
otherwiseboolean hasUncommitedChanges()
true
, if there are any uncommitted changes, false
otherwiseESRemoteProject getRemoteProject() throws ESException
ESRemoteProject
on a server this local project is associated with.
ESException
- in case any error occurs while retrieving the remote projectESLocalProjectId getLocalProjectId()
ESRemoteProject
. It is intended to identify a local copy of a remote
project.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |