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 of Create, which is then added to the underlying object's PendingActions 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 a Create pending action object initialized with the specified parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAutoUniqueContainmentName() Returns true 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, returns false.
java.lang.String	getClassId() Returns a String containing the identifier (GUID) or symbolic name of the class of object to be created.
java.lang.Boolean	getDefineSecurityParentage() Returns a Boolean value indicating whether the security parentage should be automatically set.
java.lang.String	getObjectId() Returns a String 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

Methods inherited from class java.lang.Object

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

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 a Create pending action object initialized with the specified parameters.

Parameters:

classId - A String containing the identifier (GUID) or symbolic name of the class of object to be created.

objectId - A String 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 to ReferentialContainmentRelationship and DynamicReferentialContainmentRelationship objects.

reservationType - Specifies the reservation type (collaborative, exclusive, or extracted from the object store). This parameter only applies to versionable objects. Specifying null causes the reservation type to be set to the value of the object store's DefaultReservationType property. This parameter is ignored if the Create action is combined with a Checkin action.

defineSecurityParentage - Specifies whether the SecurityParent property of the object pointed to by the ReferentialContainmentRelationship object's Head property is set to the ReferentialContainmentRelationship object (in the same transaction). This parameter is ignored for create actions on all underlying objects except ReferentialContainmentRelationship and DynamicReferentialContainmentRelationship.

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 a Boolean value indicating whether the security parentage should be automatically set. This method is only valid for ReferentialContainmentRelationship and DynamicReferentialContainmentRelationship objects.

Returns:

true if the SecurityParent property of the object pointed to by the ReferentialContainmentRelationship object's Head property is set to the ReferentialContainmentRelationship object (in the same transaction). Otherwise, returns false.

getClassId

public java.lang.String getClassId()

Returns a String 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 a String 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()

Returns true 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, returns false.

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.