The IDocumentLifecycleAction type exposes the following members.

ToggleMethods

Type NameDescription
Public methodAddPendingAction
Adds the specified pending action to this object's PendingActions collection.
Note Note: You probably won't directly manipulate an object's pending actions in this manner. You will more likely call wrapper methods such as Delete and Checkin, which add a pending action to the collection.)
(Inherited from IIndependentlyPersistableObject.)
Public methodChangeClass
Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The ChangeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
  • Any user-defined properties that exist in the new class but not in the original class are set to the default value defined by the new class (or to null if there is no default defined).
  • Any user-defined properties that exist in both the original and the new class that are writable and have the same value (including null) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class.
  • Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.
  • Property constraints for the new class (for example, required values, choice lists, ranges) are not enforced.

When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

  • The document has no current lifecycle policy.
  • The document is either a reservation object, or is the current version object and is not reserved.

Changing the document class of a document object has no effect on the storage location of the document’s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer’s Guide.

Public methodClearPendingActions
Clears out the list of pending actions for this object. For example, if you called Delete() without subsequently calling Save, then called ClearPendingActions(), the Delete pending action would no longer be in the object's pending actions list. This effectively cancels changes not yet saved.
(Inherited from IIndependentlyPersistableObject.)
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodDelete
Adds a Delete pending action to this object's PendingActions collection. You must subsequently commit the change to the repository. (See PendingAction for more information about pending actions.)

For IVersionSeries, all document versions are deleted.

For ICmRecoveryItem, this method deletes the item contained within the ICmRecoveryBin object. It also deletes all recoverable objects represented by the ICmRecoveryItem object.

(Inherited from IIndependentlyPersistableObject.)
Public methodFetchPropertiesOverloaded.
Public methodFetchPropertyOverloaded.
Public methodGetAccessAllowed
Returns a value representing a bit mask of access rights granted to the user requesting this object.
(Inherited from IIndependentlyPersistableObject.)
Public methodGetClassName
Returns the name of the class from which this object is instantiated.
(Inherited from IEngineObject.)
Public methodGetConnection
Returns a Connection object that represents a logical connection to the FileNet P8 domain. The returned Connection object is used as input to methods such as factory instantiation methods.
(Inherited from IEngineObject.)
Public methodGetObjectReference
Returns an object reference that represents the object's identity.

The ID of an independent object is the class name and ID of the object. The ID can be a path, GUID, or name of the object.

(Inherited from IIndependentObject.)
Public methodGetObjectStore
Returns a reference to the object store to which this object is persisted.
(Inherited from IRepositoryObject.)
Public methodGetPendingActions
Returns the pending actions for this object.
(Inherited from IIndependentlyPersistableObject.)
Public methodGetSuperClasses
Returns a String array specifying the names of the superclasses of the class from which this object is instantiated.
(Inherited from IEngineObject.)
Public methodGetUpdateSequenceNumber
Returns the update sequence number (USN) for this object.

You can use the returned value to determine if the object has been modified since some earlier fetch of the same object.

An IndependentlyPersistableObject has an update sequence number (USN), which is an Integer value on the object that protects it against concurrent updates. The USN value increases monotonically with each update to the object. When you update the object, the USN from the retrieved object is checked against the currently persisted USN value. If the values are different, the operation fails.

As a special case, a USN value of Null causes the server-side check to be skipped during updates (this is sometimes called "unprotected update"). An IndependentlyPersistableObject instantiated by calling one of the GetInstance methods on a Factory class (such as Factory.CustomObject.GetInstance) does not fetch the object from the server, and therefore, is unaware of the persisted USN. Calling GetUpdateSequence on such an object returns Null.

(Inherited from IIndependentlyPersistableObject.)
Public methodIsCurrent
Returns a value indicating whether or not the state of this object is consistent with its state in the repository.

When one or more of the object's properties are "dirty" (have been marked as changed since the last time they were saved), IsCurrent returns False. You can then do one of the following:

  • Save changes to the persistent store. (You can either call the Save method or add the object to an UpdatingBatch then call UpdateBatch, which effectively calls Save on each IndependentlyPersistableObject in the batch.)
  • Call the object's Refresh method to cancel the changes and restore the object's state to that of the persistent store.
  • Remove dirty properties by calling RemoveFromCache.
(Inherited from IIndependentlyPersistableObject.)
Public methodRaiseEvent
Raises a custom event for this ISubscribable object. For example, you can define a custom event class in the Content Engine for an operation such as publishing a document, then specify the custom event in a call to the raiseEvent method on a IDocument object after you call the publish method on that document.

Before you can use this method, the following conditions must be met:

  • An appropriate CustomEvent object must exist.
  • A subscription subscribes to the ISubscribable object; that is, the subscription's SubscriptionTarget property has been set to this ISubscribable object.
  • A subscription subscribes to the custom event to be raised; that is, the subscription's SubscribedEvents property has been set to a ISubscribedEventList collection that includes the custom event.
(Inherited from ISubscribable.)
Public methodRefreshOverloaded.
Public methodSaveOverloaded.
Public methodSetUpdateSequenceNumber
Sets the update sequence number (USN) for this object. You can cause update sequence checking to be skipped for this object by setting the USN value to Null.
(Inherited from IIndependentlyPersistableObject.)

ToggleSee Also