Package com.webmethods.portal.service.version

Interface ISandbox

All Superinterfaces:

ISnapshot

public interface ISandbox
extends ISnapshot

This interface extends ISnapshot as the base object for the IBranch. Most of the work on the resource is done in the snapshot for the Version Control system. These methods provide the generic resource management for an action and or state on a Sanbox in the version control system.

Field Summary

Fields inherited from interface com.webmethods.portal.service.version.ISnapshot

ORIGIN_ALL, ORIGIN_CREATED, ORIGIN_REF

Method Summary

Modifier and Type	Method	Description
void	deleteResource(IResource resource)	Remove all version for a resource in a sandbox
List<IResource>	getDeletedResources(int begin, int end)	Getting a list of resources deleted on a sandbox.
List<IVersion>	getEffectiveVersions(int begin, int end)	Returns version that are marked as effective on sandbox.
Map<String,String>	getResultOfChange()	Returns map between submitted resources ID and new resources IDs that resource get after calling saveToBranch.
IVersion	modifyVersion(IVersion version)	Creates or modifies the version from a previous version.
void	moveVersion(ISnapshot snapshot, List<IResource> resourceList)	Sync a sandbox from a snapshot on a branch with a list of resources to include in the Sync.
void	removeEffectiveVersion(IVersion version)	Removes the version as the effective and reverts the versoin on the sandbox to the default version.
ISnapshot	saveToBranch()	Save the snapshot to the branch.
void	setAsEffectiveVersion(IVersion version)	Set a version to the efffective version in a sandbox.
void	syncFrom(ISnapshot snapshot, List<IResource> resourceList, List<IVersion> effectiveVersionList, String message)	Sync a sandbox from a snapshot on a branch with a list of resources to include in the Sync.
void	unSyncFrom(ISnapshot snapshot)	Removes all of the versioning information (ie.
void	updateSandbox(ISnapshot snapshot, List<IVersion> effectiveVersionList)	Updates a sandbox based off of a snapshot.

Methods inherited from interface com.webmethods.portal.service.version.ISnapshot

getBranch, getId, getIndex, getName, getNext, getPrev, getRootVersions, getSourceSyncs, getTime, getVersionFor, getVersions, getVersions, hasResource

Method Details

modifyVersion

IVersion modifyVersion(IVersion version)
                throws VersionException

Creates or modifies the version from a previous version.

Throws:

VersionException

deleteResource

void deleteResource(IResource resource)
             throws VersionException

Remove all version for a resource in a sandbox

Throws:

VersionException

getEffectiveVersions

List<IVersion> getEffectiveVersions(int begin,
 int end)
                             throws VersionException

Returns version that are marked as effective on sandbox. When saving to a branch these version that will take precedence over any in the target branch.

Parameters:

begin - the start index in to a list of versions

end - the end index in to a list of versions

Throws:

VersionException

getDeletedResources

List<IResource> getDeletedResources(int begin,
 int end)
                             throws VersionException

Getting a list of resources deleted on a sandbox. Unless these have been undeleted.

Parameters:

begin - the start index in to a list of resources

end - the end index in to a list of resources

Throws:

VersionException

syncFrom

void syncFrom(ISnapshot snapshot,
 List<IResource> resourceList,
 List<IVersion> effectiveVersionList,
 String message)
       throws VersionException

Sync a sandbox from a snapshot on a branch with a list of resources to include in the Sync.

Parameters:

snapshot - the snapshot to sync from

resourceList - a list of resources to include in the sandbox

effectiveVersionList - a list of versions to take precedent in the sandbox

message - a description or message to save with the sync

Throws:

VersionException

moveVersion

void moveVersion(ISnapshot snapshot,
 List<IResource> resourceList)
          throws VersionException

Sync a sandbox from a snapshot on a branch with a list of resources to include in the Sync.

Parameters:

snapshot - the snapshot to sync from

resourceList - a list of resources to include in the sandbox

Throws:

VersionException

updateSandbox

void updateSandbox(ISnapshot snapshot,
 List<IVersion> effectiveVersionList)
            throws VersionException

Updates a sandbox based off of a snapshot. Effective versions will will take the newest version when a conflict occurs.

Parameters:

snapshot - the snapshot to sync from

effectiveVersionList - a list of versions to take precedent in the sandbox

Throws:

VersionException

unSyncFrom

void unSyncFrom(ISnapshot snapshot)
         throws VersionException

Removes all of the versioning information (ie. resources, versions) accesable from the sink.

Parameters:

snapshot - the snapshot to un-sync from

Throws:

VersionException

setAsEffectiveVersion

void setAsEffectiveVersion(IVersion version)
                    throws VersionException

Set a version to the efffective version in a sandbox.

Parameters:

version - set this version object to the effective version on a sandbox

Throws:

VersionException

removeEffectiveVersion

void removeEffectiveVersion(IVersion version)
                     throws VersionException

Removes the version as the effective and reverts the versoin on the sandbox to the default version.

Parameters:

version - removes this version object as the effective version on a sandbox

Throws:

VersionException

saveToBranch

ISnapshot saveToBranch()
                throws VersionException

Save the snapshot to the branch.

Throws:

VersionException

getResultOfChange

Map<String,String> getResultOfChange()
                              throws VersionException

Returns map between submitted resources ID and new resources IDs that resource get after calling saveToBranch. If map doesn't container particular resource id - means that id was not changed

Throws:

VersionException