com.filenet.api.action
Class Lock
- java.lang.Object
-
- com.filenet.api.action.PendingAction
-
- com.filenet.api.action.Lock
-
- All Implemented Interfaces:
- java.io.Serializable
public class Lock extends PendingAction
Represents a pending action for locking an object. Calling a method that locks an object automatically creates an instance ofLock
, which is then added to the underlying object'sPendingActions
collection.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description Lock(java.lang.Long timeOut, java.lang.String owner)
Creates a new instance of aLock
pending action object initialized with the specified parameters.
-
Method Summary
Methods Modifier and Type Method and Description java.lang.String
getOwner()
Returns aString
containing the intended value of theLockOwner
property of the underlying object.java.lang.Long
getTimeout()
Returns the number of seconds that the underlying object is intended to be locked.-
Methods inherited from class com.filenet.api.action.PendingAction
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString
-
-
-
-
Constructor Detail
-
Lock
public Lock(java.lang.Long timeOut, java.lang.String owner)
Creates a new instance of aLock
pending action object initialized with the specified parameters. You typically do not need to explicitly create aLock
instance. Calling lock-related methods creates an instance ofLock
and adds it to the underlying object'sPendingActions
collection. (See thelock
,updateLock
,fetchAndLockObject
, andunlock
methods.)- Parameters:
timeOut
- The new value for the underlying object'sLockTimeout
property. The timeout value is the number of seconds that the object is intended to be locked.owner
- AString
specifying the intended owner of the lock. The value of this property is simply a custom string that has no real effect in determining the user of the lock. The owner specified by this property is not validated against any user or group known to the Content Engine. This value can be any string, and is used to populate the underlying object'sLockOwner
property. It does not represent the actual user of the lock, which is recorded internally by the server. If not supplied, defaults to the short principal name of the requesting user.- Throws:
E_REQUIRED_VALUE_ABSENT
- iftimeout
parameter value isnull
. (Thrown by the server on a subsequent
call.)save
-
-
Method Detail
-
getTimeout
public java.lang.Long getTimeout()
Returns the number of seconds that the underlying object is intended to be locked.- Returns:
- The lock timeout value.
-
getOwner
public java.lang.String getOwner()
Returns aString
containing the intended value of theLockOwner
property of the underlying object.- Returns:
- A
String
containing the name of the user holding the lock.
-
-