Retrieves an object of the Domain class by the specified symbolic name. The Connection object you pass in to this method provides information necessary to establish communication with the Content Engine server.

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.


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

Syntax

Visual Basic (Declaration)
Public Shared Function FetchInstance( _ 
   ByVal conn As IConnection,  _ 
   ByVal name As String,  _ 
   ByVal filter As PropertyFilter _ 
) As IDomain
C#
public static IDomain FetchInstance(
   IConnection conn,
   string name,
   PropertyFilter filter
)
C++
public:
 static IDomain FetchInstance(
   IConnection conn,
   String name,
   PropertyFilter filter
)
J#
public static IDomain FetchInstance(
   IConnection conn,
   string name,
   PropertyFilter filter
)
JScript
public static  function FetchInstance(
   conn : IConnection,
   name : String,
   filter : PropertyFilter
) : IDomain

Parameters

conn
A Connection object for establishing the connection to the Content Engine server.
name
The name of domain to retrieve. If null, this method retrieves the default domain.
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

A Domain object.

See Also