Retrieves an object of the DocumentClassDefinition 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 details, see the description of the filter parameter.

Use this method to retrieve class definitions for Document objects. However, to retrieve the DocumentClassDefinition for a DocumentClassDefinition object, use Factory.SubscribableClassDefinition.FetchInstance.


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function FetchInstance( _ 
   ByVal os As IObjectStore,  _ 
   ByVal objectIdentity As String,  _ 
   ByVal filter As PropertyFilter _ 
) As IDocumentClassDefinition
C#
public static IDocumentClassDefinition FetchInstance(
   IObjectStore os,
   string objectIdentity,
   PropertyFilter filter
)
C++
public:
 static IDocumentClassDefinition FetchInstance(
   IObjectStore os,
   String objectIdentity,
   PropertyFilter filter
)
J#
public static IDocumentClassDefinition FetchInstance(
   IObjectStore os,
   string objectIdentity,
   PropertyFilter filter
)
JScript
public static  function FetchInstance(
   os : IObjectStore,
   objectIdentity : String,
   filter : PropertyFilter
) : IDocumentClassDefinition

Parameters

os
The ObjectStore object in which this class instance is located.
objectIdentity
A String that identifies the object. This value can be the ID (in GUID format) or symbolic name of the object to retrieve.
filter
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 DocumentClassDefinition object.

See Also