com.webmethods.portal.service.version

Interface IVersion

All Known Subinterfaces:

IVersionedContainer, IVersionedStorage, IViewableVersion

public interface IVersion

This interface is the base object for the IVersionedStorage and IVersionedContainer. These methods provide the generic version management for any item in version control.

Method Summary

Modifier and Type	Method and Description
List<IVersion>	getAllPrevious(int begin, int end) Get all versions before this one
String	getComment() Get the comment on this version
ISnapshot	getCreatedOn() Get then snapshot when this version was created
String	getId() Get the ID for this version item
String	getName() Get the Name for this version item
List<IVersion>	getNext() Get the next version
List<IVersion>	getPrevious() Get the previous version
IResource	getResource() Get the IResource for this version
String	getThingInfo() Gets the metadata of the thing from the version object that was persistanced in the version control system.
Time	getTime() Get the Time for when this item was versioned
void	setComment(String comment) Set the comment on this version
void	setName(String name) Set the Name
void	setThingInfo(String thingInfo) Sets the metadata of the thing on the version object for persistance in the version control system.

Method Detail

getId

String getId()
      throws VersionException

Get the ID for this version item

Returns:

the ID

Throws:

VersionException

getName

String getName()
        throws VersionException

Get the Name for this version item

Returns:

the Name

Throws:

VersionException

getTime

Time getTime()
      throws VersionException

Get the Time for when this item was versioned

Returns:

the Time created

Throws:

VersionException

getResource

IResource getResource()
               throws VersionException

Get the IResource for this version

Returns:

the resource for this version

Throws:

VersionException

getNext

List<IVersion> getNext()
                throws VersionException

Get the next version

Returns:

a next version if there is one

Throws:

VersionException

getPrevious

List<IVersion> getPrevious()
                    throws VersionException

Get the previous version

Returns:

a previous version if there is one

Throws:

VersionException

getAllPrevious

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

Get all versions before this one

Parameters:

begin -

end -

Returns:

a list of all versions previous

Throws:

VersionException

getCreatedOn

ISnapshot getCreatedOn()
                throws VersionException

Get then snapshot when this version was created

Returns:

the snapshot of the branch

Throws:

VersionException

setName

void setName(String name)
      throws VersionException

Set the Name

Parameters:

name - the name for this version

Throws:

VersionException

setComment

void setComment(String comment)
         throws VersionException

Set the comment on this version

Parameters:

name - the comment for this version

Throws:

VersionException

getComment

String getComment()
           throws VersionException

Get the comment on this version

Returns:

the Comment

Throws:

VersionException

setThingInfo

void setThingInfo(String thingInfo)
           throws VersionException

Sets the metadata of the thing on the version object for persistance in the version control system. This is used when the version is restored or is the latest in the system

Parameters:

thingInfo - the serialized version of the thing in the metadata system

Throws:

VersionException

getThingInfo

String getThingInfo()
             throws VersionException

Gets the metadata of the thing from the version object that was persistanced in the version control system. This is used when the version is restored or is the latest in the system

Parameters:

thingInfo - the serialized version of the thing in the metadata system

Throws:

VersionException