public static class Factory.WorkflowDefinition
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static WorkflowDefinition |
createInstance(ObjectStore os,
java.lang.String classId)
Creates a new instance of the subclassable
WorkflowDefinition class to be persisted in the specified object store. |
static WorkflowDefinition |
createInstance(ObjectStore os,
java.lang.String classId,
Id id)
Creates a new instance of the subclassable
WorkflowDefinition class to be persisted in the specified object store. |
static WorkflowDefinition |
createInstance(ObjectStore os,
java.lang.String classId,
Id id,
Id versionSeriesId,
ReservationType reservationType)
Creates a new instance of the subclassable
WorkflowDefinition class, to be persisted in the specified object store. |
static WorkflowDefinition |
fetchInstance(ObjectStore os,
Id objectId,
PropertyFilter filter)
Retrieves an object of the
WorkflowDefinition class
by the specified object ID from the specified object store. |
static WorkflowDefinition |
fetchInstance(ObjectStore os,
java.lang.String path,
PropertyFilter filter)
Retrieves an object of the
WorkflowDefinition class as specified by a path
and an object store. |
static WorkflowDefinition |
getInstance(ObjectStore os,
java.lang.String className,
Id objectId)
Constructs an instance of the subclassable
WorkflowDefinition class from the
specified object store. |
static WorkflowDefinition |
getInstance(ObjectStore os,
java.lang.String className,
java.lang.String path)
Retrieves the instance of the subclassable
WorkflowDefinition class as specified by a path and an object store. |
public static WorkflowDefinition createInstance(ObjectStore os, java.lang.String classId, Id id, Id versionSeriesId, ReservationType reservationType)
WorkflowDefinition
class, to be persisted in the specified object store.
Once you create an object, it 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.
The classId
parameter is the identifier for the type of class to be instantiated. 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. Specifying an ID (GUID) for this instance via the id
parameter is optional; if one is not specified, an ID for the new object is automatically generated.
When this object is created, an associated VersionSeries
object is also created to hold the document
versions of this object. Optionally specifying an ID (GUID) via the versionSeriesId
parameter will
assign an ID to the newly created VersionSeries
object; if one is not specified, an ID for the new
VersionSeries
object is automatically generated. The reservationType
parameter specifies
a ReservationType
constant to indicate the type of reservation for the new object (collaborative or
exclusive) or whether the reservation type is the same as the default object store setting. A collaborative
reservation is a reservation that any user with the appropriate permissions can check in, modify, or delete.
An exclusive reservation is a reservation that only the user who creates the reservation can check in, modify, or delete.
os
- The ObjectStore
object in which this class instance is located.classId
- The identifier for the type of class to be instantiated.id
- An optional ID to assign to the new object.versionSeriesId
- An optional ID to assign to the new VersionSeries
object.reservationType
- The type of reservation for the new object.public static WorkflowDefinition getInstance(ObjectStore os, java.lang.String className, java.lang.String path)
WorkflowDefinition
class as specified by a path and an 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 in which this class instance is located.className
- The type of class of the object to retrieve, which can be specified as the class name constant
or the symbolic name for the class.path
- The path of the object to retrieve.public static WorkflowDefinition fetchInstance(ObjectStore os, java.lang.String path, PropertyFilter filter)
WorkflowDefinition
class as specified by a path
and an object store. Unlike the getInstance
, 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 path 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.public static WorkflowDefinition getInstance(ObjectStore os, java.lang.String className, Id objectId)
WorkflowDefinition
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 WorkflowDefinition fetchInstance(ObjectStore os, Id objectId, PropertyFilter filter)
WorkflowDefinition
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 WorkflowDefinition createInstance(ObjectStore os, java.lang.String classId)
WorkflowDefinition
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 WorkflowDefinition createInstance(ObjectStore os, java.lang.String classId, Id id)
WorkflowDefinition
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.