com.filenet.api.action
Class MoveContent
- java.lang.Object
-
- com.filenet.api.action.PendingAction
-
- com.filenet.api.action.MoveContent
-
- All Implemented Interfaces:
- java.io.Serializable
public class MoveContent extends PendingAction
Represents a pending action for moving the content data of an object to a new storage location. When an object calls themoveContent
method, the API automatically creates an instance of theMoveContent
class and adds it to the underlying object's collection ofPendingAction
objects.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description MoveContent(java.lang.String targetPolicyId, java.lang.Boolean moveAllVersions)
Creates a new instance of aMoveContent
pending action object.
-
Method Summary
Methods Modifier and Type Method and Description java.lang.Boolean
getMoveAllVersions()
Returns whether to move the content data of every version of a document.java.lang.String
getTargetPolicyId()
Returns the ID of the target storage area for the object content data.-
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
-
MoveContent
public MoveContent(java.lang.String targetPolicyId, java.lang.Boolean moveAllVersions)
Creates a new instance of aMoveContent
pending action object.- Parameters:
targetPolicyId
- AString
specifying the ID of the target storage area for the object content.moveAllVersions
- ABoolean
specifying whether to move the content data of every version of a document (true
) or the content data of the current document version only (false
).- Throws:
E_OBJECT_NOT_FOUND
- if targetPolicyId isnull
. Thrown when you call thesave
method.CONTENT_SA_DELETES_NOT_ALLOWED
- if the old content could not be deleted.CONTENT_CA_DELETE_FAILED_RETENTION_CHECK
- if the rentention check failed.CONTENT_FXCA_OPERATION_FAILED_CONTENT_IS_MIGRATING
- if a content migration has already been initalized.CONTENT_CA_FAILED_TEMP_CREATION
- if a temporary file could not be created (the disk may be full).
-
-
Method Detail
-
getTargetPolicyId
public java.lang.String getTargetPolicyId()
Returns the ID of the target storage area for the object content data.- Returns:
- A
String
specifying the ID of the storage area.
-
getMoveAllVersions
public java.lang.Boolean getMoveAllVersions()
Returns whether to move the content data of every version of a document.- Returns:
true
if the content data of every version of a document will be moved;false
if the content data of the current document version only will be moved.
-
-