com.sap.portal.admin.editor

Class EditorLockingStatus.StatusEnum

java.lang.Object
  extended by com.sap.portal.admin.editor.EditorLockingStatus.StatusEnum
Enclosing class:
EditorLockingStatus

public static class EditorLockingStatus.StatusEnum
extends Object


Field Summary
static EditorLockingStatus.StatusEnum EXISTING_LOCK
          Returns a status object that indicates that the resource is already locked.
 short mm_status
          Returns a short value that indicates the status of the lock.
static EditorLockingStatus.StatusEnum NEW_LOCK
          Returns a status object that indicates that the resource is locked with a new lock.
static EditorLockingStatus.StatusEnum RESOURCE_CHECKED_OUT
          Indicates the resource was checked out by another entity.
static EditorLockingStatus.StatusEnum RESOURCE_CHECKED_OUT_BY_ME
          Indicates the resource was checked out by this user.
static EditorLockingStatus.StatusEnum RESOURCE_IN_HOLD
          Returns a status object that indicates that the resource is locked, but the resource can be taken if the user requests.
static EditorLockingStatus.StatusEnum RESOURCE_IS_LOCKED
          Indicates the resource was locked by another entity.
protected static short SATAUS_EXISTING_LOCK
          Defines a value for the constant SATAUS_EXISTING_LOCK.
protected static short SATAUS_NEW_LOCK
          Defines a value for the constant SATAUS_NEW_LOCK.
protected static short SATAUS_RESOURCE_CHECKED_OUT
           
protected static short SATAUS_RESOURCE_CHECKED_OUT_BY_ME
           
protected static short SATAUS_RESOURCE_IN_HOLD
          Defines a value for the constant SATAUS_RESOURCE_IN_HOLD.
protected static short SATAUS_RESOURCE_IS_LOCKED
          Defines a value for the constant SATAUS_RESOURCE_IS_LOCKED.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SATAUS_NEW_LOCK

protected static final short SATAUS_NEW_LOCK
Defines a value for the constant SATAUS_NEW_LOCK.

See Also:
Constant Field Values

SATAUS_EXISTING_LOCK

protected static final short SATAUS_EXISTING_LOCK
Defines a value for the constant SATAUS_EXISTING_LOCK.

See Also:
Constant Field Values

SATAUS_RESOURCE_IS_LOCKED

protected static final short SATAUS_RESOURCE_IS_LOCKED
Defines a value for the constant SATAUS_RESOURCE_IS_LOCKED.

See Also:
Constant Field Values

SATAUS_RESOURCE_IN_HOLD

protected static final short SATAUS_RESOURCE_IN_HOLD
Defines a value for the constant SATAUS_RESOURCE_IN_HOLD.

See Also:
Constant Field Values

SATAUS_RESOURCE_CHECKED_OUT

protected static final short SATAUS_RESOURCE_CHECKED_OUT
See Also:
Constant Field Values

SATAUS_RESOURCE_CHECKED_OUT_BY_ME

protected static final short SATAUS_RESOURCE_CHECKED_OUT_BY_ME
See Also:
Constant Field Values

NEW_LOCK

public static EditorLockingStatus.StatusEnum NEW_LOCK
Returns a status object that indicates that the resource is locked with a new lock. The editor framework registers the lock, and the editor is opened for editing, if no other veto is raised.


EXISTING_LOCK

public static EditorLockingStatus.StatusEnum EXISTING_LOCK
Returns a status object that indicates that the resource is already locked. The editor is opened for editing, if no other veto is raised. Registering the lock is not required.


RESOURCE_IN_HOLD

public static EditorLockingStatus.StatusEnum RESOURCE_IN_HOLD
Returns a status object that indicates that the resource is locked, but the resource can be taken if the 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.


RESOURCE_IS_LOCKED

public static EditorLockingStatus.StatusEnum RESOURCE_IS_LOCKED
Indicates the resource was locked by another entity. The editor framework opens the editor in read-only mode, and an end- user message is displayed.


RESOURCE_CHECKED_OUT

public static EditorLockingStatus.StatusEnum RESOURCE_CHECKED_OUT
Indicates the resource was checked out by another entity. The editor framework opens the editor in read-only mode, and an end- user message is displayed.


RESOURCE_CHECKED_OUT_BY_ME

public static EditorLockingStatus.StatusEnum RESOURCE_CHECKED_OUT_BY_ME
Indicates the resource was checked out by this user. The editor framework opens the editor in normal mode, and an end- user message is displayed.


mm_status

public short mm_status
Returns a short value that indicates the status of the lock.

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