com.filenet.api.action
Class Create
- java.lang.Object
-
- com.filenet.api.action.PendingAction
-
- com.filenet.api.action.Create
-
- All Implemented Interfaces:
- java.io.Serializable
public class Create extends PendingAction
Represents a pending action for creating an object. Calling a method that creates an object automatically creates an instance ofCreate
, which is then added to the underlying object'sPendingActions
collection.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description Create(java.lang.String classId, java.lang.String objectId, java.lang.Boolean autoUniqueContainmentName, ReservationType reservationType, java.lang.Boolean defineSecurityParentage, java.lang.String versionSeriesId)
Creates a new instance of aCreate
pending action object initialized with the specified parameters.
-
Method Summary
Methods Modifier and Type Method and Description java.lang.Boolean
getAutoUniqueContainmentName()
Returnstrue
if a unique containment name can be automatically generated for this pending action's underlying object when the new object is saved to the object store; otherwise, returnsfalse
.java.lang.String
getClassId()
Returns aString
containing the identifier (GUID) or symbolic name of the class of object to be created.java.lang.Boolean
getDefineSecurityParentage()
Returns aBoolean
value indicating whether the security parentage should be automatically set.java.lang.String
getObjectId()
Returns aString
containing the identifier (GUID) of the underlying object of this pending action.ReservationType
getReservationType()
Returns the reservation type (collaborative, exclusive, or extracted from the object store) of the underlying object of this pending action.java.lang.String
getVersionSeriesId()
Returns the version series ID for the underlying object of this pending action.-
Methods inherited from class com.filenet.api.action.PendingAction
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString
-
-
-
-
Constructor Detail
-
Create
public Create(java.lang.String classId, java.lang.String objectId, java.lang.Boolean autoUniqueContainmentName, ReservationType reservationType, java.lang.Boolean defineSecurityParentage, java.lang.String versionSeriesId)
Creates a new instance of aCreate
pending action object initialized with the specified parameters.- Parameters:
classId
- AString
containing the identifier (GUID) or symbolic name of the class of object to be created.objectId
- AString
containing the identifier (GUID) of object to be created. If an ID is not specified, one is automatically generated.autoUniqueContainmentName
-true
if a unique containment name can be automatically generated for the new object; otherwise,false
. This parameter only applies toReferentialContainmentRelationship
andDynamicReferentialContainmentRelationship
objects.reservationType
- Specifies the reservation type (collaborative, exclusive, or extracted from the object store). This parameter only applies to versionable objects. Specifyingnull
causes the reservation type to be set to the value of the object store'sDefaultReservationType
property. This parameter is ignored if theCreate
action is combined with aCheckin
action.defineSecurityParentage
- Specifies whether theSecurityParent
property of the object pointed to by theReferentialContainmentRelationship
object'sHead
property is set to theReferentialContainmentRelationship
object (in the same transaction). This parameter is ignored for create actions on all underlying objects exceptReferentialContainmentRelationship
andDynamicReferentialContainmentRelationship
.versionSeriesId
- Specifies the version series ID for the underlying object. This parameter only applies to versionable objects.
-
-
Method Detail
-
getDefineSecurityParentage
public java.lang.Boolean getDefineSecurityParentage()
Returns aBoolean
value indicating whether the security parentage should be automatically set. This method is only valid forReferentialContainmentRelationship
andDynamicReferentialContainmentRelationship
objects.- Returns:
true
if theSecurityParent
property of the object pointed to by theReferentialContainmentRelationship
object'sHead
property is set to theReferentialContainmentRelationship
object (in the same transaction). Otherwise, returnsfalse
.
-
getClassId
public java.lang.String getClassId()
Returns aString
containing the identifier (GUID) or symbolic name of the class of object to be created.- Returns:
- A
String
containing the class identifier.
-
getObjectId
public java.lang.String getObjectId()
Returns aString
containing the identifier (GUID) of the underlying object of this pending action.- Returns:
- A
String
containing the object identifier.
-
getAutoUniqueContainmentName
public java.lang.Boolean getAutoUniqueContainmentName()
Returnstrue
if a unique containment name can be automatically generated for this pending action's underlying object when the new object is saved to the object store; otherwise, returnsfalse
.- Returns:
- A
Boolean
indicating whether the object's containment name can be auto-generated. - See Also:
AutoUniqueName
-
getReservationType
public ReservationType getReservationType()
Returns the reservation type (collaborative, exclusive, or extracted from the object store) of the underlying object of this pending action.- Returns:
- A
ReservationType
object.
-
getVersionSeriesId
public java.lang.String getVersionSeriesId()
Returns the version series ID for the underlying object of this pending action.- Returns:
- A
String
containing the version series identifier.
-
-