com.sap.portal.admin.editor

Class EditorLockingStatus

java.lang.Object
  extended by 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:


Nested Class Summary
static class EditorLockingStatus.StatusEnum
           
 
Constructor Summary
EditorLockingStatus(EditorLockingStatus.StatusEnum status, String userId, String sessionId)
          A constructor that sets a lock.
 
Method Summary
 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
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/admin/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice