Retrieves and locks the specified object from this
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
ObjectStore
object. The object can be specified as a string containing a GUID, a symbolic name, or a path. 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
for the
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
parameter.
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public MustOverride Function FetchAndLockObject( _ ByVal classIdent As String, _ ByVal objectId As Id, _ ByVal timeout As Long, _ ByVal lockOwner As String, _ ByVal filter As PropertyFilter _ ) As IIndependentObject |
C# |
---|
public abstract IIndependentObject FetchAndLockObject( string classIdent, Id objectId, long timeout, string lockOwner, PropertyFilter filter ) |
C++ |
---|
public: IIndependentObject FetchAndLockObject( String classIdent, Id objectId, __int64 timeout, String lockOwner, PropertyFilter filter ) abstract |
J# |
---|
public abstract IIndependentObject FetchAndLockObject( string classIdent, Id objectId, long timeout, string lockOwner, PropertyFilter filter ) |
JScript |
---|
public abstract
function FetchAndLockObject( classIdent : String, objectId : Id, timeout : long, lockOwner : String, filter : PropertyFilter ) : IIndependentObject |
Parameters
- classIdent
- The class of the object to be retrieved and locked. This value may be specified as an ID (GUID) or a symbolic name.
- objectId
- The ID of the object to retrieve. This value must be specified as an ID (a string containing a GUID).
- timeout
- An integer that represents the number of seconds after which the lock will expire. The range of values is 0 to 2147483647 (
) seconds.Integer.MAX_VALUE
- lockOwner
- A
representing the user name to be assigned as the owner of the lock on this object. 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 applications, such as WebDAV to identify the user who has locked the object.String
- filter
- A
object that represents information for controlling which property values (and with what level of detail and recursion) to return. IfPropertyFilter
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (null
properties with a state ofPropertyEngineObject
orPropertyState.UNEVALUATED
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.PropertyState.REFERENCE
Return Value
An object of the requested type.