com.webmethods.portal.service.version

Interface IVersionSession

public interface IVersionSession

This interface is the interface which users interact with the version control system.

Method Summary

Modifier and Type	Method and Description
void	close() put your documentation comment here
IBranch	createAuxiliaryBranch(IBranch primaryBranch, String name, String desc) Create a auxiliary branch which you can merge to from a primary branch
IBranch	createPrimaryBranch(String name, String desc) Create a new branch for this session
IVersionedContainer	createVersionedContainer(IBranch branch, String name) Create a container object in a branch, this in-turn this creates IResource and IVersion
IVersionedStorage	createVersionedStorage(IBranch branch, String name) Create a storage object in a branch, this in-turn this creates IResource and IVersion
void	deleteBranch(IBranch branch) deletes the branch from the version control system and all resources, versions
void	deleteResource(IResource resource) deletes the resource from the version control system and all versions
IBranch	getBranchById(String id) Get a branch by it's id
List<IBranch>	getBranches() Get all of the branches for this session
IBranch	getDefaultBranch() Get the default branch for this session
IResource	getResourceById(String id) Get a Resource by it's id
ISnapshot	getSnapshotById(String id) Get the Snapshot by it's id
IVersion	getVersionById(String id) Get a Version by it's id
IVersionService	getVersionService() get the service for this session

Method Detail

getDefaultBranch

IBranch getDefaultBranch()
                  throws VersionException,
                         VersionCommunicationException

Get the default branch for this session

Returns:

the default branch

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

getBranches

List<IBranch> getBranches()
                   throws VersionException,
                          VersionCommunicationException

Get all of the branches for this session

Returns:

a list of branches that exist on the session

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

getBranchById

IBranch getBranchById(String id)
               throws VersionException,
                      VersionCommunicationException

Get a branch by it's id

Parameters:

id - the ID of the branch

Returns:

the branch

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

getResourceById

IResource getResourceById(String id)
                   throws VersionException,
                          VersionCommunicationException

Get a Resource by it's id

Parameters:

id - the ID of the resource

Returns:

the resource

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

getVersionById

IVersion getVersionById(String id)
                 throws VersionException,
                        VersionCommunicationException

Get a Version by it's id

Parameters:

id - the ID of the version

Returns:

the version

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

getSnapshotById

ISnapshot getSnapshotById(String id)
                   throws VersionException,
                          VersionCommunicationException

Get the Snapshot by it's id

Parameters:

id - the ID of the Snapshot

Returns:

the snapshot

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

createPrimaryBranch

IBranch createPrimaryBranch(String name,
                            String desc)
                     throws VersionException,
                            VersionCommunicationException

Create a new branch for this session

Parameters:

name - the name of the branch

desc - the description of the branch

Returns:

the branch

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

createAuxiliaryBranch

IBranch createAuxiliaryBranch(IBranch primaryBranch,
                              String name,
                              String desc)
                       throws VersionException,
                              VersionCommunicationException

Create a auxiliary branch which you can merge to from a primary branch

Parameters:

primaryBranch - the branch to merge from

name - the name of the branch to create

desc - the description of the branch to create

Returns:

the branch

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

createVersionedStorage

IVersionedStorage createVersionedStorage(IBranch branch,
                                         String name)
                                  throws VersionException,
                                         VersionCommunicationException

Create a storage object in a branch, this in-turn this creates IResource and IVersion

Parameters:

branch - the branch to create the verison in

name - the name of the verison

Returns:

the version

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

createVersionedContainer

IVersionedContainer createVersionedContainer(IBranch branch,
                                             String name)
                                      throws VersionException,
                                             VersionCommunicationException

Create a container object in a branch, this in-turn this creates IResource and IVersion

Parameters:

branch - the branch to create the verison in

name - the name of the verison

Returns:

the version

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

deleteBranch

void deleteBranch(IBranch branch)
           throws VersionException,
                  VersionCommunicationException

deletes the branch from the version control system and all resources, versions

Parameters:

branch - to delete

Throws:

VersionException

VersionCommunicationException

deleteResource

void deleteResource(IResource resource)
             throws VersionException,
                    VersionCommunicationException

deletes the resource from the version control system and all versions

Parameters:

resource - to delete

Throws:

VersionException

VersionCommunicationException

close

void close()
    throws VersionException,
           VersionCommunicationException

put your documentation comment here

Throws:

VersionException, - VersionCommunicationException

VersionException

VersionCommunicationException

getVersionService

IVersionService getVersionService()

get the service for this session