com.sap.portal.admin.editor

Class EditorLockingStatus

java.lang.Object

com.sap.portal.admin.editor.EditorLockingStatus

public class EditorLockingStatus
extends Object

The class that represents the status of the editor lock. The status information includes the user ID and the session ID that currently hold the lock.
The following lock statuses are available:

• NEW_LOCK: The resource is locked with a new lock. The editor framework registers this lock, and the editor is opened for editing (if no other veto is raised).
• EXISTING_LOCK: The resource is already locked by this user and session. The editor is opened for editing (if no other veto is raised). Registration is not required.
• RESOURCE_IS_LOCKED: The resource is locked by another entity. The editor framework opens the editor in read-only mode, and an end-user message is presented.
• RESOURCE_IN_HOLD: The resource is locked. However, the resource can be taken if the current user requests. The editor framework presents a question, and if the user chooses yes, to enforce the lock, the editor framework calls the ILockingPolicy.getLock method using the enforce parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorLockingStatus.StatusEnum

Constructor Summary

Constructors

Constructor and Description
EditorLockingStatus(EditorLockingStatus.StatusEnum status, String userId, String sessionId) A constructor that sets a lock.

Method Summary

Modifier and Type	Method and Description
String	getSessionId() Gets the session ID that is holding the lock.
EditorLockingStatus.StatusEnum	getStatus() Gets the status of the lock.
String	getUserId() Gets the user ID that is holding the lock.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditorLockingStatus

public EditorLockingStatus(EditorLockingStatus.StatusEnum status,
                           String userId,
                           String sessionId)

A constructor that sets a lock.

Parameters:

status - a lock status

userId - a user ID holding the lock

sessionId - a session ID holding the lock

Method Detail

getSessionId

public String getSessionId()

Gets the session ID that is holding the lock.

Returns:

the session ID

getStatus

public EditorLockingStatus.StatusEnum getStatus()

Gets the status of the lock.

Returns:

the lock status

getUserId

public String getUserId()

Gets the user ID that is holding the lock.

Returns:

the user ID