Promotes an unreleased minor version of this document to a released major version. This method changes the current released major version (if it exists) to a superseded major version, but does not delete any document versions (including content) from the document's version series, therefore allowing you to continue to have access to all version changes. Note that you can promote frozen document versions and documents that are not versioning-enabled (documents whose IsVersioningEnabled property is set to false).

To successfully promote a document, the following requirements must be met or an error will occur:

  • The document must be the latest minor version (VersionStatus property is set to IN_PROCESS).
  • The document must be the current version (IsCurrentVersion property is set to true).
  • The user must have the appropriate access rights (MAJOR_VERSION).
  • The document must not be reserved (IsReserved property is set to false).

After a successful call to PromoteVersion, the Content Engine performs the following steps on the document version that is being promoted:

  • Applies the versioning security template (if it exists and is enabled) for the RELEASED state.
  • Sets the MinorVersionNumber property to 0.
  • Increments the MajorVersionNumber property by 1.
  • Sets the VersionStatus property to RELEASED.

In addition, the Content Engine performs the following steps on the previous major document version that is being superseded:

  • Sets the VersionStatus property to SUPERSEDED.
  • Applies the versioning security template (if it exists and is enabled) for the SUPERSEDED state.


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Sub PromoteVersion()
C#
void PromoteVersion()
C++
void PromoteVersion() abstract 
J#
void PromoteVersion()
JScript
function PromoteVersion()

See Also