Retrieves an object of the ClassDescription class by the specified class
identity. 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.ClassDescription.fetchInstance = function(scope, classIdentity, filter); |
Parameters
- scope
- Type: FileNet.Api.Core..::.IScope
The object to which this ClassDescription is scoped.
For more information, see the IScope
interface description.
- classIdentity
- Type: System..::.String
A String that identifies the class. The value can be a
class ID (in GUID format) or class symbolic name.
- 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
ClassDescription object.