com.filenet.api.core
Class Factory.Domain

java.lang.Object
  extended by com.filenet.api.core.Factory.Domain
Enclosing class:
Factory

public static class Factory.Domain
extends java.lang.Object


Method Summary
static Domain fetchInstance(Connection conn, java.lang.String name, PropertyFilter filter)
          Retrieves an object of the Domain class by the specified symbolic name.
static Domain getInstance(Connection conn, java.lang.String name)
          Retrieves an instance of the Domain class by the specified symbolic name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static Domain getInstance(Connection conn,
                                 java.lang.String name)
Retrieves an instance 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 does not verify the existence of the requested object on the server; it simply returns a local reference without making a round-trip to the server. The local reference is not affiliated with an object of this class type until you perform a function on the object (for example, fetch a property value) that causes a round-trip to the Content Engine server.

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.
Returns:
A reference to a Domain object.

fetchInstance

public static Domain fetchInstance(Connection conn,
                                   java.lang.String name,
                                   PropertyFilter filter)
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 more information, see the description of the filter parameter.

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.
Returns:
A Domain object.


© Copyright IBM Corporation 2006, 2009. All rights reserved.