|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.core.Factory.Realm
public static class Factory.Realm
Method Summary | |
---|---|
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,
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,
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 |
---|
public static Realm fetchCurrent(Connection connection, PropertyFilter filter)
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.
connection
- 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.
public static RealmSet fetchAll(Connection connection, PropertyFilter filter)
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.
connection
- 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.
RealmSet
object containing all Realm
objects in the domain.public static Realm getInstance(Connection connection, java.lang.String name)
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 Engine server.
connection
- A Connection
object for establishing the connection to the Content 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)
.
public static Realm fetchInstance(Connection connection, java.lang.String name, PropertyFilter filter)
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.
connection
- A Connection
object for establishing the connection to the Content 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |