com.sap.workspaces.module

Interface ILocking

All Superinterfaces:

IWorkspacesService

public interface ILocking
extends IWorkspacesService

Provides tools to manage locking of workspace modules

Since:

1.1

Method Summary

LockInfo	forceLock(IModuleContext context) Forces lock on the specified module for the current user, regardless of the module’s locking status
LockInfo	getLockInfo(IModuleContext context) Returns the locking status of the specified module context
LockInfo	lock(IModuleContext context) Locks the specified module for the current user.
boolean	releaseLock(IModuleContext context) Releases the lock on the specified module, if it was locked by the current user
boolean	releaseLocks(String pageID, com.sap.security.api.IUser user) Releases all modules locked by the specified user in the specified page

Method Detail

lock

LockInfo lock(IModuleContext context)

Locks the specified module for the current user.

Parameters:

context - the module context.

Returns:

A LockInfo object representing the locking status of the module

releaseLock

boolean releaseLock(IModuleContext context)

Releases the lock on the specified module, if it was locked by the current user

Parameters:

context - - the module context

Returns:

True, if the lock on the module was successfully released

releaseLocks

boolean releaseLocks(String pageID,
                     com.sap.security.api.IUser user)

Releases all modules locked by the specified user in the specified page

Parameters:

pageID - the ID of a workspace page.

Returns:

True if all the locked modules in the specified page were released, false otherwise, or if the page ID is not valid .

forceLock

LockInfo forceLock(IModuleContext context)

Forces lock on the specified module for the current user, regardless of the module’s locking status

Parameters:

context - the module context

Returns:

A LockInfo object representing the locking status of the module

getLockInfo

LockInfo getLockInfo(IModuleContext context)

Returns the locking status of the specified module context

Parameters:

context - the module context

Returns:

A LockInfo object representing the locking status of the module