Retrieves and locks the specified object from this
ObjectStore object. Use
parameters on this method to specify the owner of the lock and the lock timeout value.
This method always makes a round-trip to the server.
You can optionally include a filter to control which properties to return with
the object. If you pass in null for the filter parameter, this method
returns values for all non-object properties and returns placeholders for all
object-valued properties. For more information, see the description of the filter
parameter.
Namespace:
FileNet.Api.Core
Assembly:
FileNet.Api (in FileNet.Api.dll)
Visual Basic (Declaration) |
---|
Function FetchAndLockObject ( _
classIdent As String, _
objectIdent As String, _
timeout As Long, _
lockOwner As String, _
filter As PropertyFilter _
) As IIndependentObject |
JavaScript |
---|
function fetchAndLockObject(classIdent, objectIdent, timeout, lockOwner, filter); |
Parameters
- classIdent
- Type: System..::.String
The class of the object to be retrieved and locked. You can
specify the value of this parameter as an ID (a string containing a GUID) or a symbolic name.
- objectIdent
- Type: System..::.String
The ID of the object to retrieve. You can specify the value
of this parameter as an ID (a string containing a GUID), a path, or a symbolic name.
- timeout
- Type: System..::.Int64
An integer that represents the number of seconds after which the lock will expire.
The range of values is 0 to 2147483647 (Integer.MAX_VALUE) seconds.
- lockOwner
- Type: System..::.String
A String representing the user name to be assigned as
the owner of the lock on this object. The value defaults to the short principal name of the
requesting user. The value is strictly advisory and is not validated against user
or group names known to the Content Engine. The value can be used by client applications
to identify the user who has locked the object.
- filter
- Type: FileNet.Api.Property..::.PropertyFilter
A PropertyFilter object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED or
PropertyState.REFERENCE); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.
Return Value
An object of the requested type.