com.webmethods.portal.service.version

Interface ISnapshot

All Known Subinterfaces:

ISandbox

public interface ISnapshot

This interface is the base object for the ISandbox. 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. A snapshot it a picture in time of the branch IBranch which it was taken from.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORIGIN_ALL
static int	ORIGIN_CREATED
static int	ORIGIN_REF

Method Summary

Modifier and Type	Method and Description
IBranch	getBranch() Get the branch IBranch that the snapshot was created from.
String	getId() Get the ID for the snapshot
long	getIndex() The index location in time that the snapshot exisits.
String	getName() Get the name of the Snapshot
ISnapshot	getNext() Get the next snapshot in history
ISnapshot	getPrev() Get the previous snapshot in history
List<IVersion>	getRootVersions(int begin, int end) Get the root version which the snapshot was based off of.
List<ISync>	getSourceSyncs(int begin, int end) Get the Syncs which the snapshot interacted with.
Time	getTime() Get the Time that the snapshot was created or modified
IVersion	getVersionFor(IResource resource) Get me the IVersion for the IResource in this snapshot
List<ISync>	getVersions(int begin, int end) Get the Syncs which the snapshot interacted with.
List<IVersion>	getVersions(int originKind, String ofClass, int begin, int end) Get a list of IVersions
boolean	hasResource(IResource resource) Does a snapshot contain a IResource

Field Detail

ORIGIN_ALL

static final int ORIGIN_ALL

See Also:

Constant Field Values

ORIGIN_REF

static final int ORIGIN_REF

See Also:

Constant Field Values

ORIGIN_CREATED

static final int ORIGIN_CREATED

See Also:

Constant Field Values

Method Detail

getId

String getId()
      throws VersionException

Get the ID for the snapshot

Returns:

a string which is the ID

Throws:

VersionException

getName

String getName()
        throws VersionException

Get the name of the Snapshot

Returns:

String the name

Throws:

VersionException

getTime

Time getTime()
      throws VersionException

Get the Time that the snapshot was created or modified

Returns:

the time of creation

Throws:

VersionException

getIndex

long getIndex()
       throws VersionException

The index location in time that the snapshot exisits.

Returns:

long the ID of the Snapshot in serries

Throws:

VersionException

getNext

ISnapshot getNext()
           throws VersionException

Get the next snapshot in history

Returns:

a snapshot object

Throws:

VersionException

getPrev

ISnapshot getPrev()
           throws VersionException

Get the previous snapshot in history

Returns:

a snapshot object

Throws:

VersionException

getBranch

IBranch getBranch()
           throws VersionException

Get the branch IBranch that the snapshot was created from.

Returns:

IBranch the branch that the snapshot was taken from

Throws:

VersionException

getSourceSyncs

List<ISync> getSourceSyncs(int begin,
                           int end)
                    throws VersionException

Get the Syncs which the snapshot interacted with.

Parameters:

being - the index location to begin

end - the index location to end

Returns:

a list of (@link ISync} objects

Throws:

VersionException

getVersions

List<ISync> getVersions(int begin,
                        int end)
                 throws VersionException

Get the Syncs which the snapshot interacted with.

Parameters:

being - the index location to begin

end - the index location to end

Returns:

a list of (@link ISync} objects

Throws:

VersionException

getVersions

List<IVersion> getVersions(int originKind,
                           String ofClass,
                           int begin,
                           int end)
                    throws VersionException

Get a list of IVersions

Parameters:

being - the index location to begin

end - the index location to end

ofClass - the type of version

originKind - the type of version on a branch

Returns:

a list of IVersion

Throws:

VersionException

getRootVersions

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

Get the root version which the snapshot was based off of.

Parameters:

being - the index location to begin

end - the index location to end

Returns:

a list of (@link IVersion} objects

Throws:

VersionException

hasResource

boolean hasResource(IResource resource)
             throws VersionException

Does a snapshot contain a IResource

Parameters:

resource - the object to evaluate

Returns:

boolean does it exisit

Throws:

VersionException

getVersionFor

IVersion getVersionFor(IResource resource)
                throws VersionException

Get me the IVersion for the IResource in this snapshot

Parameters:

resource - to get the version from

IVersion - the version object from the resource

Throws:

VersionException