com.filenet.api.core

Class Factory.Realm

java.lang.Object

com.filenet.api.core.Factory.Realm

Enclosing class:

Factory

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

Method Summary

Modifier and Type	Method and Description
static RealmSet	fetchAll(Connection connection, PropertyFilter filter) Returns all realms available in the domain.
static Realm	fetchCurrent(Connection connection, PropertyFilter filter) Returns the realm for the current user.
static Realm	fetchInstance(Connection connection, Id id, PropertyFilter filter) Retrieves an object of the Realm class by the specified connection and ID.
static Realm	fetchInstance(Connection connection, java.lang.String name, PropertyFilter filter) Retrieves an object of the Realm class by the specified connection and symbolic name.
static Realm	getInstance(Connection connection, Id id) Constructs an instance of the Realm class by the specified connection and ID.
static Realm	getInstance(Connection connection, java.lang.String name) Constructs an instance of the Realm class by the specified connection and symbolic name.

Methods inherited from class java.lang.Object

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

Method Detail

fetchCurrent

public static Realm fetchCurrent(Connection connection,
                                 PropertyFilter filter)

Returns the realm for the current user. 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:

connection - A Connection object for establishing the connection to the Content Platform 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:

The realm of which the current user is a part.

fetchAll

public static RealmSet fetchAll(Connection connection,
                                PropertyFilter filter)

Returns all realms available in the domain. 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:

connection - A Connection object for establishing the connection to the Content Platform 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:

A RealmSet object containing all Realm objects in the domain.

getInstance

public static Realm getInstance(Connection connection,
                                java.lang.String name)

Constructs an instance of the Realm class by the specified connection and symbolic name. 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 Platform Engine server.

Parameters:

connection - A Connection object for establishing the connection to the Content Platform Engine server.

name - The symbolic name of the class instance to constrauct. Can be null, in which case the method returns the same Realm object as would be returned by a call to fetchCurrent(connection, filter).

Returns:

A reference to an object of the requested type.

fetchInstance

public static Realm fetchInstance(Connection connection,
                                  java.lang.String name,
                                  PropertyFilter filter)

Retrieves an object of the Realm class by the specified connection and symbolic name. 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:

connection - A Connection object for establishing the connection to the Content Platform Engine server.

name - The symbolic name of the class instance 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.

Returns:

An object of the requested type.

getInstance

public static Realm getInstance(Connection connection,
                                Id id)

Constructs an instance of the Realm class by the specified connection and ID. 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:

connection - A Connection object for establishing the connection to the Content Platform Engine server.

id - The ID (GUID) of the object to retrieve.

Returns:

A reference to an object of the requested type.

fetchInstance

public static Realm fetchInstance(Connection connection,
                                  Id id,
                                  PropertyFilter filter)

Retrieves an object of the Realm class by the specified connection and ID. 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.

Parameters:

connection - A Connection object for establishing the connection to the Content Platform Engine server.

id - The ID (GUID) 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.

Returns:

An object of the requested type.