com.filenet.api.core

Class Factory.CmIndexRequest

java.lang.Object

com.filenet.api.core.Factory.CmIndexRequest

Enclosing class:

Factory

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

Method Summary

Methods

Modifier and Type	Method and Description
static CmIndexRequest	fetchInstance(ObjectStore os, Id objectId, PropertyFilter filter) Retrieves an object of the CmIndexRequest class by the specified object ID from the specified object store.
static CmIndexRequest	getInstance(ObjectStore os, Id objectId) Constructs an instance of the CmIndexRequest class from the specified object store.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CmIndexRequest getInstance(ObjectStore os,
                         Id objectId)

Constructs an instance of the CmIndexRequest class from the specified object store. 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:

os - The ObjectStore object in which to persist the object.

objectId - The ID (GUID) of this class instance.

Returns:

A reference to an object of the requested type.

fetchInstance

public static CmIndexRequest fetchInstance(ObjectStore os,
                           Id objectId,
                           PropertyFilter filter)

Retrieves an object of the CmIndexRequest class by the specified object ID from the specified object store. 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:

os - The ObjectStore object in which this class instance is located.

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