Retrieves an object of the Domain class by the specified name.
The Connection object you pass in to this method provides information
necessary to establish communication with the server.
Namespace:
FileNet.Api.CoreThis 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.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Shared Function FetchInstance ( _ conn As IConnection, _ name As String, _ filter As PropertyFilter _ ) As IDomain |
C# |
---|
public static IDomain FetchInstance( IConnection conn, string name, PropertyFilter filter ) |
Visual C++ |
---|
public: static IDomain^ FetchInstance( IConnection^ conn, String^ name, PropertyFilter^ filter ) |
JavaScript |
---|
FileNet.Api.Core.Domain.fetchInstance = function(conn, name, filter); |
Parameters
- conn
- Type: FileNet.Api.Core..::.IConnection
A Connection object for establishing the connection to the server.
- name
- Type: System..::.String
The name of domain to retrieve. If null, this method retrieves the default domain.NOTE: The server does not currently check a non-null name argument for correctness, but it might be checked in future releases. Therefore, you should either use the correct domain name or pass null to get the default domain as determined by the Connection object.
- 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.