org.eclipse.emf.emfstore.client

Interface ESRemoteProject

All Superinterfaces:

ESProject

All Known Implementing Classes:

ESRemoteProjectImpl

public interface ESRemoteProject
extends ESProject

Represents a remote project on the server.

Author:

emueller, wesendon

Method Summary

Modifier and Type	Method and Description
ESLocalProject	checkout(String name, ESUsersession usersession, ESPrimaryVersionSpec versionSpec, org.eclipse.core.runtime.IProgressMonitor monitor) Checkouts the project in the given version into the local workspace.
ESLocalProject	checkout(String name, ESUsersession usersession, org.eclipse.core.runtime.IProgressMonitor monitor) Checkouts the project in the HEAD version into the local workspace.
ESLocalProject	checkout(String name, org.eclipse.core.runtime.IProgressMonitor monitor) Checkouts the project in its HEAD version into the local workspace.
void	delete(ESUsersession usersession, org.eclipse.core.runtime.IProgressMonitor monitor) Deletes the remote project on the server.
void	delete(org.eclipse.core.runtime.IProgressMonitor monitor) Deletes the remote project on the server.
ESLocalProject	fetch(String name, ESUsersession session, ESPrimaryVersionSpec versionSpec, org.eclipse.core.runtime.IProgressMonitor monitor)
List<ESBranchInfo>	getBranches(ESUsersession usersession, org.eclipse.core.runtime.IProgressMonitor monitor) Returns all branches for the current project.
ESPrimaryVersionSpec	getHeadVersion(org.eclipse.core.runtime.IProgressMonitor monitor) Returns the HEAD version of the project.
List<ESHistoryInfo>	getHistoryInfos(ESUsersession usersession, ESHistoryQuery<? extends ESHistoryQuery<?>> query, org.eclipse.core.runtime.IProgressMonitor monitor) Retrieves a part of the project's version history from the server based on the given query.
ESServer	getServer() Returns the project's server.
ESPrimaryVersionSpec	resolveVersionSpec(ESUsersession usersession, ESVersionSpec versionSpec, org.eclipse.core.runtime.IProgressMonitor monitor) Resolves a ESVersionSpec to a ESPrimaryVersionSpec by querying the server.

Methods inherited from interface org.eclipse.emf.emfstore.client.ESProject

addTag, getBranches, getGlobalProjectId, getHistoryInfos, getProjectName, removeTag, resolveVersionSpec

Method Detail

getServer

ESServer getServer()

Returns the project's server.

Returns:

server

fetch

ESLocalProject fetch(String name,
                     ESUsersession session,
                     ESPrimaryVersionSpec versionSpec,
                     org.eclipse.core.runtime.IProgressMonitor monitor)
              throws ESException

Parameters:

name - the name of the copy being created during the fetch

session - the user session that will be used by the ESServerCall to fetch the project

versionSpec - the version that should be fetched.

monitor - the IProgressMonitor that is used during checkout in order to indicate progress

Returns:

the fetched project

Throws:

ESException - in case an error occurs during fetch

checkout

ESLocalProject checkout(String name,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws ESException

Checkouts the project in its HEAD version into the local workspace.

The ESUsersession used for checking out the project will be injected.

Parameters:

name - the name of the copy being created during the checkout

monitor - the progress monitor that is used during checkout in order to indicate progress

Returns:

the checked out project

Throws:

ESException - in case an error occurs during checkout

checkout

ESLocalProject checkout(String name,
                        ESUsersession usersession,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws ESException

Checkouts the project in the HEAD version into the local workspace.

The caller must provide the ESUsersession used for checking out the project, e.g. by specifying the session that was lastly used in an ESServer.

The caller also must specify which specific ESVersionSpec to checkout. If the HEAD version should get checked out, the ESVersionFactory must be used, which can be fetched via ESVersionSpec.FACTORY.

Parameters:

name - the name of the copy being created during the checkout

usersession - the user session that will be used by the ESServerCall to checkout the project

monitor - the IProgressMonitor that is used during checkout in order to indicate progress

Returns:

the checked out project

Throws:

ESException - in case an error occurs during checkout

See Also:

ESVersionFactory, ESServer.getLastUsersession()

checkout

ESLocalProject checkout(String name,
                        ESUsersession usersession,
                        ESPrimaryVersionSpec versionSpec,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws ESException

Checkouts the project in the given version into the local workspace.

The caller must provide the ESUsersession used for checking out the project, e.g. by specifying the session that was lastly used in an ESServer.

The caller also must specify which specific ESVersionSpec to checkout. If the HEAD version should get checked out, the ESVersionFactory must be used, which can be fetched via ESVersionSpec.FACTORY.

Parameters:

name - the name of the copy being created during the checkout

usersession - the user session that will be used by the ESServerCall to checkout the project

versionSpec - the version that should be checked out.

monitor - the IProgressMonitor that is used during checkout in order to indicate progress

Returns:

the checked out project

Throws:

ESException - in case an error occurs during checkout

See Also:

ESVersionFactory, ESServer.getLastUsersession()

resolveVersionSpec

ESPrimaryVersionSpec resolveVersionSpec(ESUsersession usersession,
                                        ESVersionSpec versionSpec,
                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                 throws ESException

Resolves a ESVersionSpec to a ESPrimaryVersionSpec by querying the server.

Parameters:

usersession - the user session that will be used by the ESServerCall to resolve the given ESVersionSpec

versionSpec - the version specifier to resolve

monitor - an IProgressMonitor instance that is used to indicate progress while resolving the version specifier

Returns:

the resolved primary version

Throws:

ESException - in case an error occurs while resolving the version

getBranches

List<ESBranchInfo> getBranches(ESUsersession usersession,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws ESException

Returns all branches for the current project.

Parameters:

usersession - the user session used to fetch the branch information

monitor - an IProgressMonitor instance that is used to indicate progress while fetching the branch information

Returns:

a list containing information about all branches for the current project

Throws:

ESException - in case an error occurs while retrieving the branch information for the project

getHistoryInfos

List<ESHistoryInfo> getHistoryInfos(ESUsersession usersession,
                                    ESHistoryQuery<? extends ESHistoryQuery<?>> query,
                                    org.eclipse.core.runtime.IProgressMonitor monitor)
                             throws ESException

Retrieves a part of the project's version history from the server based on the given query. Use ESHistoryQueryFactory to generate query objects.

Parameters:

usersession - the user session that will be used by the ESServerCall to fetch the history information

query - the query to be performed in order to fetch the history information

monitor - an IProgressMonitor instance that is used to indicate progress while fetching the history information

Returns:

a list of history infos

Throws:

ESException - in case an error occurs while retrieving the history information

delete

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

Deletes the remote project on the server.

Specified by:

delete in interface ESProject

Parameters:

monitor - an IProgressMonitor used to indicate progress

Throws:

ESException - in case an error occurs during the deletion of the project

delete

void delete(ESUsersession usersession,
            org.eclipse.core.runtime.IProgressMonitor monitor)
     throws ESException

Deletes the remote project on the server.

Parameters:

usersession - the user session that will be used by the ESServerCall to delete the remote project

monitor - an IProgressMonitor used to indicate progress

Throws:

ESException - in case an error occurs during the deletion of the project

getHeadVersion

ESPrimaryVersionSpec getHeadVersion(org.eclipse.core.runtime.IProgressMonitor monitor)
                             throws ESException

Returns the HEAD version of the project.

Parameters:

monitor - an IProgressMonitor used to indicate progress

Returns:

the HEAD version

Throws:

ESException - in case an error occurs while fetching the HEAD version of the project