com.webmethods.portal.mech.version

Interface IVersionServiceMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

public interface IVersionServiceMechanics
extends IMechanics

Interface, which provides top level API for version service

Method Summary

Modifier and Type	Method and Description
IVersionSession	getAdminSession() gets admin's version service session, uses default IMetaContext of version service
IVersionSession	getAdminSession(IMetaContext mc) gets admin's version service session, overrides IMetaContext to be used in the session
IVersionSession	getSession(String sUser, String sPassword) gets version service session, uses default IMetaContext of version service
IVersionSession	getSession(String sUser, String sPassword, IMetaContext mc) gets version service session, overrides IMetaContext to be used in the session
IListView<IView>	listVersions(String sBranchId, String sVersionId) lists all versions for given branch
IViewableVersion	viewVersion(String sVersionId)

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Detail

getSession

IVersionSession getSession(String sUser,
                           String sPassword)
                    throws PortalException

gets version service session, uses default IMetaContext of version service

Parameters:

sUser -

sPassword -

Returns:

version service session

Throws:

PortalException

getSession

IVersionSession getSession(String sUser,
                           String sPassword,
                           IMetaContext mc)
                    throws PortalException

gets version service session, overrides IMetaContext to be used in the session

Parameters:

sUser -

sPassword -

mc - IMetaContext to be used in the session

Returns:

version service session

Throws:

PortalException

getAdminSession

IVersionSession getAdminSession()
                         throws PortalException

gets admin's version service session, uses default IMetaContext of version service

Returns:

version service session

Throws:

PortalException

getAdminSession

IVersionSession getAdminSession(IMetaContext mc)
                         throws PortalException

gets admin's version service session, overrides IMetaContext to be used in the session

Parameters:

mc - IMetaContext to be used in the session

Returns:

version service session

Throws:

PortalException

listVersions

IListView<IView> listVersions(String sBranchId,
                              String sVersionId)
                       throws PortalException

lists all versions for given branch

Parameters:

sBranchId -

sVersionId -

Returns:

Throws:

PortalException

viewVersion

IViewableVersion viewVersion(String sVersionId)
                      throws PortalException

Parameters:

sVersionId -

Returns:

Throws:

PortalException