com.sap.portal.admin.editor
Class EditorLockingStatus

java.lang.Object
  |
  +--com.sap.portal.admin.editor.EditorLockingStatus

public class EditorLockingStatus

extends java.lang.Object

EditorLockingStatus Holds the status of the locking, the user id and the session id that currently holds the lock. The possible statuses are:

• NEW_LOCK - The resource was locked with a new lock. The editor framework register this lock, and the editor will be opened for edit (if no other veto will be raised)
• EXISTING_LOCK - The resource was alredy locked by this user and session, so no special treatment should be made, and the editor will be opened for edit (if no other veto will be raised), no registration is needed.
• RESOURCE_IS_LOCKED - The resource was locked by other 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, it can be taken if the current user wants. The editor framework presents a question, and if the user will choose yes- to enforce the lcok, the editor framework will operate the get lock with enforce flag.

Inner Class Summary

static class

EditorLockingStatus.StatusEnum

Constructor Summary

EditorLockingStatus(EditorLockingStatus.StatusEnum status, java.lang.String userId, java.lang.String sessionId)
Creates a new EditorLockingStatus object.

Method Summary

java.lang.String	getSessionId()
EditorLockingStatus.StatusEnum	getStatus()
java.lang.String	getUserId()

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,
                           java.lang.String userId,
                           java.lang.String sessionId)

Creates a new EditorLockingStatus object.

Parameters:

status - One of the possible statuses of the lock.

userId - The user id that currently holds the lock

sessionId - The session id that currently holds the lock

Method Detail

getSessionId

public java.lang.String getSessionId()

Returns:

The session id that currently holds the lock

getStatus

public EditorLockingStatus.StatusEnum getStatus()

Returns:

the status of the lock.

getUserId

public java.lang.String getUserId()

Returns:

The user id that currently holds the lock