The IVersionSeries 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 methodCancelCheckout
Cancels the check-out reservation held on this document or version series by deleting the reservation object associated with it. Any changes made to the reservation object are lost. If the reservation object is an exclusive reservation (the object's ReservationType property is set to EXCLUSIVE), only the user who checked out the document can cancel the check out, or must have both WRITE_OWNER and DELETE access rights. Note that this method is provided only as a convenience method for canceling a checkout; all it does is delete the reservation version held by the document or version series from which it is called.

After a document's reservation object is deleted, the Content Engine performs the following steps on the reserved document version:

  • Sets the IsReserved property to false.
  • Sets the ReservationType property to null.

An error occurs if the document is not checked out or is a newly created object that has never been checked in.

Public methodCheckout
Creates a reservation object that can be modified and checked in as a new version of this document. The reservation object can be accessed from this document's Reservation property. You can either specify the type of checkout reservation (exclusive or collaborative) or use the default checkout reservation setting of the object store.

To successfully check out a document, the following requirements must be met or an exception will be thrown:

  • The document must be the current version (IsCurrentVersion property is set to true).
  • The document must not already be checked out (IsReserved property is set to false).
  • The document must be version-enabled (IsVersioningEnabled property is set to true).
  • The user must have the appropriate access rights (MINOR_VERSION to check out a minor version, or MAJOR_VERSION to check out a released version).

After a successful call to Checkout, the Content Engine performs the following steps:

  • Applies the versioning security template for the reservation state (if it exists and is enabled) to the newly created reservation object.
  • Sets the IsReserved property of the checked-out document to true.
  • Sets the ReservationType property of the checked-out document to the appropriate setting: (COLLABORATIVE or EXCLUSIVE).
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 methodMarkForDeletion
Marks the object for deletion and associates it with the specified recovery bin. An object marked for deletion is soft deleted; that is, the object is recoverable. See Recovery Bin Concepts.
Public methodMoveContent
Moves the content data of an object to a new storage area. For IVersionSeries, this method moves the content for all associated document versions.

After a successful call to the MoveContent method, the content data is deleted from the original location unless the content data is IBM FileNet Content Federation Services for Image Services federated content. To enable deletion of IBM FileNet Content Federation Services for Image Services federated content from its original location, set the com.filenet.replication.EnableLegacyMoveContentBehaviour JVM parameter to true for your application server. For information about how to assign JVM parameter values for your application server, see Setting JVM parameters.

You can force content to be encrypted, re-encrypted, or decrypted based on the current encryption configuration for the destination storage area. Likewise, you can force content to be compressed or decompressed based on the content compression configuration for the destination storage area. For more information, see Content encryption and Content compression.

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