com.sap.mdm.data
Class RecordLockingResult

java.lang.Object
  extended bycom.sap.mdm.data.RecordLockingResult

public class RecordLockingResult
extends Object

A container class indicating the locking/unlocking result.


Field Summary
static int LOCK_BY_CURRENT_SESSION
           
static int LOCK_BY_OTHER_SESSION
           
static int LOCK_FAILURE
           
static int NOT_LOCK
           
 
Constructor Summary
RecordLockingResult(TableId tableId, RecordId recordId, int status)
          Constructor of the RecordLockingResult object with the specified parameters.
RecordLockingResult(TableId tableId, RecordId recordId, int status, String userName)
          Constructor of the RecordLockingResult object with the specified parameters.
 
Method Summary
 RecordId getRecordId()
          Returns the record Id.
 int getStatus()
          Returns the locking status of a record.
 TableId getTableId()
          Returns the table Id the record is from.
 String getUserName()
          Returns the name of the user who has the lock on the record.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOCK_FAILURE

public static final int LOCK_FAILURE
See Also:
Constant Field Values

NOT_LOCK

public static final int NOT_LOCK
See Also:
Constant Field Values

LOCK_BY_CURRENT_SESSION

public static final int LOCK_BY_CURRENT_SESSION
See Also:
Constant Field Values

LOCK_BY_OTHER_SESSION

public static final int LOCK_BY_OTHER_SESSION
See Also:
Constant Field Values
Constructor Detail

RecordLockingResult

public RecordLockingResult(TableId tableId,
                           RecordId recordId,
                           int status)
Constructor of the RecordLockingResult object with the specified parameters.

Parameters:
tableId - the ID of the table to which the record belongs
recordId - the record Id
status - the locking status of the record, such as LOCK_BY_OTHER_SESSION

RecordLockingResult

public RecordLockingResult(TableId tableId,
                           RecordId recordId,
                           int status,
                           String userName)
Constructor of the RecordLockingResult object with the specified parameters.

Parameters:
tableId - the ID of the table to which the record belongs
recordId - the record Id
status - the locking status of the record, such as LOCK_BY_OTHER_SESSION
userName - the name of the user who has the lock on the record if any, otherwise null
Since:
7.1 SP08
Method Detail

getTableId

public TableId getTableId()
Returns the table Id the record is from.

Returns:
a table Id

getRecordId

public RecordId getRecordId()
Returns the record Id.

Returns:
a record Id

getStatus

public int getStatus()
Returns the locking status of a record.

Returns:
the locking status
See Also:
LOCK_FAILURE, NOT_LOCK, LOCK_BY_CURRENT_SESSION, LOCK_BY_OTHER_SESSION

getUserName

public String getUserName()
Returns the name of the user who has the lock on the record.

Returns:
The name of the user who locks the record or null.
Since:
7.1 SP08


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.