Retrieves an object of the ClassDefinition class by the specified object
identity from the specified object store. 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)
JavaScript |
---|
FileNet.Api.Core.ClassDefinition.fetchInstance = function(os, objectIdentity, filter); |
Parameters
- os
- Type: FileNet.Api.Core..::.IObjectStore
The ObjectStore object in which this class instance is located.
- objectIdentity
- Type: System..::.String
A String that identifies the object. This value can be the
ID (in GUID format), path, or name of the object to retrieve.
- 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
The requested
ClassDefinition object.