com.filenet.api.core

Class Factory.EntireNetwork

java.lang.Object

com.filenet.api.core.Factory.EntireNetwork

Enclosing class:

Factory

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

Method Summary

Methods

Modifier and Type	Method and Description
static EntireNetwork	fetchInstance(Connection conn, PropertyFilter filter) Retrieves an object of the EntireNetwork class.
static EntireNetwork	getInstance(Connection conn) Retrieves an instance of the EntireNetwork class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static EntireNetwork getInstance(Connection conn)

Retrieves an instance of the EntireNetwork class. 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.

Returns:

A reference to an EntireNetwork object.

fetchInstance

public static EntireNetwork fetchInstance(Connection conn,
                          PropertyFilter filter)

Retrieves an object of the EntireNetwork class. 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.

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:

An EntireNetwork object.