public static class Factory.Folder
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static Folder |
createInstance(ObjectStore os,
java.lang.String classId)
Creates a new instance of the subclassable
Folder class to be persisted in the specified object store. |
static Folder |
createInstance(ObjectStore os,
java.lang.String classId,
Id id)
Creates a new instance of the subclassable
Folder class to be persisted in the specified object store. |
static Folder |
fetchInstance(ObjectStore os,
Id objectId,
PropertyFilter filter)
Retrieves an object of the
Folder class
by the specified object ID from the specified object store. |
static Folder |
fetchInstance(ObjectStore os,
java.lang.String path,
PropertyFilter filter)
Retrieves an object of the
Folder class based on the specified path, and from the specified
object store. |
static Folder |
getInstance(ObjectStore os,
java.lang.String className,
Id objectId)
Constructs an instance of the subclassable
Folder class from the
specified object store. |
static Folder |
getInstance(ObjectStore os,
java.lang.String className,
java.lang.String path)
Retrieves the instance of the
Folder class based on the specified
pathname, and from the specified object store. |
public static Folder getInstance(ObjectStore os, java.lang.String className, java.lang.String path)
Folder
class based on the specified
pathname, and 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 ObjectStore
object for the object store in which this class instance is to be located.className
- A String
containing the symbolic name, or ID of the class for this instance.path
- A String
containing the full-qualified pathname of the object.public static Folder fetchInstance(ObjectStore os, java.lang.String path, PropertyFilter filter)
Folder
class based on the specified path, and 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 for the object store in which this class instance is to be located.path
- A String
containing the full-qualified pathname of the object.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 Folder getInstance(ObjectStore os, java.lang.String className, Id objectId)
Folder
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 Folder fetchInstance(ObjectStore os, Id objectId, PropertyFilter filter)
Folder
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 Folder createInstance(ObjectStore os, java.lang.String classId)
Folder
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 Folder createInstance(ObjectStore os, java.lang.String classId, Id id)
Folder
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
© Copyright IBM Corporation 2006, 2015. All rights reserved.