com.webmethods.portal.service.version

Interface IVersionService

All Superinterfaces:

IComponent, IInitializable

public interface IVersionService
extends IComponent

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_CATEGORY_NAME
static int	VERSION_UPDATE_TYPE_BRANCH
static int	VERSION_UPDATE_TYPE_EDITABLE
static int	VERSION_UPDATE_TYPE_FIXED
static String	VERSION_URI

Method Summary

Modifier and Type	Method and Description
IVersionURI	acquireURI(String uri) acquires version uri
boolean	allowSystemSession() Does this implementation of a versioning system provide a system session or user
IThingID	getServiceID() gets the service ID (for acl)
IVersionSession	getSession() Get the default session
IVersionSession	getSession(IMetaContext mc) Get the default session
IVersionSession	getSession(String userId, String password) Get a session for the version control system
IVersionSession	getSession(String userId, String password, IMetaContext mc) Get a session for the version control system
IVersion	lookup(IURI uri) lookups a version by its uri

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

Field Detail

VERSION_UPDATE_TYPE_BRANCH

static final int VERSION_UPDATE_TYPE_BRANCH

See Also:

Constant Field Values

VERSION_UPDATE_TYPE_FIXED

static final int VERSION_UPDATE_TYPE_FIXED

See Also:

Constant Field Values

VERSION_UPDATE_TYPE_EDITABLE

static final int VERSION_UPDATE_TYPE_EDITABLE

See Also:

Constant Field Values

LOG_CATEGORY_NAME

static final String LOG_CATEGORY_NAME

See Also:

Constant Field Values

VERSION_URI

static final String VERSION_URI

See Also:

Constant Field Values

Method Detail

allowSystemSession

boolean allowSystemSession()
                    throws VersionException

Does this implementation of a versioning system provide a system session or user

Returns:

true for SystemSession and false if per UserSessions

Throws:

VersionException

getSession

IVersionSession getSession(String userId,
                           String password)
                    throws VersionException

Get a session for the version control system

Parameters:

userId - the user to login as

password - the users password

Returns:

the session for the user

Throws:

VersionException

getSession

IVersionSession getSession(String userId,
                           String password,
                           IMetaContext mc)
                    throws VersionException

Get a session for the version control system

Parameters:

userId - the user to login as

password - the users password

mc - overrides IMetaContext to be used for session

Returns:

the session for the user

Throws:

VersionException

getSession

IVersionSession getSession()
                    throws VersionException

Get the default session

Returns:

the default session (for example the System Session)

Throws:

VersionException

getSession

IVersionSession getSession(IMetaContext mc)
                    throws VersionException

Get the default session

Parameters:

mc - overrides IMetaContext to be used for session

Returns:

the default session (for example the System Session)

Throws:

VersionException

getServiceID

IThingID getServiceID()
               throws VersionException

gets the service ID (for acl)

Throws:

VersionException

acquireURI

IVersionURI acquireURI(String uri)

acquires version uri

Parameters:

uri -

Returns:

lookup

IVersion lookup(IURI uri)
         throws VersionException

lookups a version by its uri

Parameters:

uri -

Returns:

Throws:

VersionException