com.webmethods.portal.service.version

Interface IBranch

public interface IBranch

This interface is implemented by the focal point of all child objects. The IBranch will also be the main entry point for all content in the branch.

Method Summary

Modifier and Type	Method and Description
List<IVersion>	getAllVersionsFor(IResource resource, int begin, int end) Get the list of all versions for a resource in a snapshot
ISnapshot	getDefaultSnapshot() Get the latest versuined snapshot for the branch
String	getDescription() Get the description for the branch
String	getId() Get the id for a branch
String	getName() Get the name for the branch
ISandbox	getSandbox() Get the sandbox for the branch
List<ISnapshot>	getSnapshots(int begin, int end) Get a list of all of the snapshots for a range
Time	getTime() Get the time that the branch was created

Method Detail

getId

String getId()
      throws VersionException

Get the id for a branch

Returns:

String the id of the branch

Throws:

VersionException

getName

String getName()
        throws VersionException

Get the name for the branch

Parameters:

String - the name of the branch

Throws:

VersionException

getDescription

String getDescription()
               throws VersionException

Get the description for the branch

Returns:

String the description of the branch

Throws:

VersionException

getTime

Time getTime()
      throws VersionException

Get the time that the branch was created

Returns:

Time of the creation of the branch

Throws:

VersionException

getDefaultSnapshot

ISnapshot getDefaultSnapshot()
                      throws VersionException

Get the latest versuined snapshot for the branch

Returns:

ISnapshot the default snapshot for the branch

Throws:

VersionException

getSandbox

ISandbox getSandbox()
             throws VersionException

Get the sandbox for the branch

Returns:

ISandbox the sandbox for the branch

Throws:

VersionException

getSnapshots

List<ISnapshot> getSnapshots(int begin,
                             int end)
                      throws VersionException

Get a list of all of the snapshots for a range

Parameters:

begin - the starting version

end - the starting version

Returns:

List a list of snapshot objects

Throws:

VersionException

getAllVersionsFor

List<IVersion> getAllVersionsFor(IResource resource,
                                 int begin,
                                 int end)
                          throws VersionException

Get the list of all versions for a resource in a snapshot

Parameters:

resource - the resource for a branch

begin - the starting version

end - the starting version

Returns:

List a list of version objects

Throws:

VersionException