de.cismet.cismap.commons.gui.attributetable

Interface FeatureLockingInterface

All Known Implementing Classes:

H2FeatureServiceLocker

public interface FeatureLockingInterface

This interface is used to lock and unlock features. See also FeatureLockerFactory

Version:

$Revision$, $Date$

Author:

therter

Method Summary

Modifier and Type	Method and Description
Class[]	getSupportedFeatureServiceClasses() Returns the supported feature services.
Object	lock(AbstractFeatureService service, boolean multiLockForSameUserAllowed) locks the given feature service.
Object	lock(Feature feature, boolean multiLockForSameUserAllowed) locks the given feature.
Object	lock(List<Feature> feature, boolean multiLockForSameUserAllowed) locks the given feature list.
void	unlock(Object unlockObject) Unlocks the feature, that is associated with the given unlock-object.

Method Detail

lock

Object lock(Feature feature,
            boolean multiLockForSameUserAllowed)
     throws LockAlreadyExistsException,
            Exception

locks the given feature.

Parameters:

feature - the feature that should be locked

multiLockForSameUserAllowed - true, iff it is allowed to lock an object that is already locked by this user

Returns:

The unlock object for the given feature. This can be used with unlock(Object)

Throws:

LockAlreadyExistsException - if the given feature is already locked

Exception - if the locking failed for some reason

lock

Object lock(List<Feature> feature,
            boolean multiLockForSameUserAllowed)
     throws LockAlreadyExistsException,
            Exception

locks the given feature list.

Parameters:

feature - the feature that should be locked

multiLockForSameUserAllowed - true, iff it is allowed to lock an object that is already locked by this user

Returns:

The unlock object for the given feature. This can be used with unlock(Object)

Throws:

LockAlreadyExistsException - if the given feature is already locked

Exception - if the locking failed for some reason

lock

Object lock(AbstractFeatureService service,
            boolean multiLockForSameUserAllowed)
     throws LockAlreadyExistsException,
            Exception

locks the given feature service.

Parameters:

service - the service that should be locked

multiLockForSameUserAllowed - true, iff it is allowed to lock an object that is already locked by this user

Returns:

The unlock object for the given service. This can be used with unlock(Object)

Throws:

LockAlreadyExistsException - if at least one feature of the given service is already locked

Exception - if the locking failed for some reason

unlock

void unlock(Object unlockObject)
     throws Exception

Unlocks the feature, that is associated with the given unlock-object.

Parameters:

unlockObject - the unlock object from lock(Feature)

Throws:

Exception - if the unlock process failed

getSupportedFeatureServiceClasses

Class[] getSupportedFeatureServiceClasses()

Returns the supported feature services.

Returns:

the supported feature services