|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.core.Factory.CustomObject
public static class Factory.CustomObject
Method Summary | |
---|---|
static CustomObject |
createInstance(ObjectStore os,
java.lang.String classId)
Creates a new instance of the subclassable CustomObject class to be persisted in the specified object store. |
static CustomObject |
createInstance(ObjectStore os,
java.lang.String classId,
Id id)
Creates a new instance of the subclassable CustomObject class to be persisted in the specified object store. |
static CustomObject |
fetchInstance(ObjectStore os,
Id objectId,
PropertyFilter filter)
Retrieves an object of the CustomObject class
by the specified object ID from the specified object store. |
static CustomObject |
fetchInstance(ObjectStore os,
java.lang.String path,
PropertyFilter filter)
Retrieves a CustomObject object using the specified path from the specified object store. |
static CustomObject |
getInstance(ObjectStore os,
java.lang.String className,
Id objectId)
Constructs an instance of the subclassable CustomObject class from the
specified object store. |
static CustomObject |
getInstance(ObjectStore os,
java.lang.String className,
java.lang.String path)
Retrieves an instance of this class from the specified object store using the supplied path. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static CustomObject getInstance(ObjectStore os, java.lang.String className, java.lang.String path)
os
- The object store from which to retrieve this instance.className
- The name of the class to retrieve. If null
, the default root
CustomObject
class is assumed.path
- The full path name of the object to retrieve.
CustomObject
object.public static CustomObject fetchInstance(ObjectStore os, java.lang.String path, PropertyFilter filter)
CustomObject
object using the specified path 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 more information,
see the description of the filter
parameter.
os
- The ObjectStore
object in which this class instance is located.path
- The full path name 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.
CustomObject
object.public static CustomObject getInstance(ObjectStore os, java.lang.String className, Id objectId)
CustomObject
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.
os
- The object store for this instance.className
- The name of the class.objectId
- The ID (GUID) of this class instance. Specifying an ID for this instance is optional; if one is not specified,
an ID for the new object is automatically generated.
public static CustomObject fetchInstance(ObjectStore os, Id objectId, PropertyFilter filter)
CustomObject
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.
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.
public static CustomObject createInstance(ObjectStore os, java.lang.String classId)
CustomObject
class to be persisted in the specified object store.
The presence of a classId
parameter on a createInstance
method indicates that the type of class being created is subclassable.
The created object does not yet exist in an object store. To persist
the created object to the object store, you must explicitly call
the save
method, or commit the object via a batch
operation. Both approaches cause a round-trip to the server.
One form of this method takes object store and class ID arguments, and another form takes object store, class ID, and object ID (GUID) arguments. Specifying an ID for this instance is optional; if one is not specified, an ID for the new object is automatically generated.
The classId
parameter is the identifier for the type of class to be created.
The identifier can be specified as the class name constant or the
symbolic name for the class. It can also be null
, in which case
an object of the base class type is returned.
ClassNames
,
ClassDescription.get_SymbolicName
public static CustomObject createInstance(ObjectStore os, java.lang.String classId, Id id)
CustomObject
class to be persisted in the specified object store.
The presence of a classId
parameter on a createInstance
method indicates that the type of class being created is subclassable.
The created object does not yet exist in an object store. To persist
the created object to the object store, you must explicitly call
the save
method, or commit the object via a batch
operation. Both approaches cause a round-trip to the server.
One form of this method takes object store and class ID arguments, and another form takes object store, class ID, and object ID (GUID) arguments. Specifying an ID for this instance is optional; if one is not specified, an ID for the new object is automatically generated.
The classId
parameter is the identifier for the type of class to be created.
The identifier can be specified as the class name constant or the
symbolic name for the class. It can also be null
, in which case
an object of the base class type is returned.
ClassNames
,
ClassDescription.get_SymbolicName
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |