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 the moveContent
method, the API automatically creates an instance of the
MoveContent
class and adds it to the underlying object's collection of PendingAction
objects.
- See Also:
- Serialized Form
Constructor Summary |
MoveContent(java.lang.String targetPolicyId,
java.lang.Boolean moveAllVersions)
Creates a new instance of a MoveContent pending action object. |
Method Summary |
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 policy 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 |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
MoveContent
public MoveContent(java.lang.String targetPolicyId,
java.lang.Boolean moveAllVersions)
- Creates a new instance of a
MoveContent
pending action object.
- Parameters:
targetPolicyId
- A String
specifying the ID of the target storage policy for the object content.moveAllVersions
- A Boolean
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 is null
.
Thrown when you call the save
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).
getTargetPolicyId
public java.lang.String getTargetPolicyId()
- Returns the ID of the target storage policy for the object content data.
- Returns:
- A
String
specifying the ID of the storage policy.
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.
© Copyright IBM Corporation 2006, 2009. All rights reserved.