com.filenet.api.admin

Interface UpgradeAddOn

All Superinterfaces:

AddOn, EngineObject, IndependentlyPersistableObject, IndependentObject, java.io.Serializable

public interface UpgradeAddOn
extends AddOn

Specifies how to upgrade a set of existing add-ons to a new set of add-ons. An UpgradeAddOn object has the following characteristics:

• It has import data, a pre-import script, and a post-import script, and is installed using the same API method (ObjectStore.installAddOn) as a normal add-on.
• It identifies the old add-on version(s) (FromVersions property) and the new add-on version(s) (ToVersions property).
• When an add-on has been successfully upgraded, the older version's AddOnInstallationRecord object is replaced with an installation record for the newer version.
• It can upgrade one or more add-ons of older versions to one or more add-ons of newer versions via a single UpgradeAddOn object. For example, when an UpgradeAddOn object with a FromVersions value of [A1, A2, A3] and a ToVersions value of [A4, A5] is installed on an object store, the AddOnInstallationRecord objects for A1, A2, and A3 are removed and replaced with AddOnInstallationRecord objects for A4 and A5.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: AddOn

Method Summary

Methods

Modifier and Type	Method and Description
IdList	get_FromVersions() Returns the value of the FromVersions property.
IdList	get_ToVersions() Returns the value of the ToVersions property.
void	set_FromVersions(IdList value) Sets the value of the FromVersions property.
void	set_ToVersions(IdList value) Sets the value of the ToVersions property.

Methods inherited from interface com.filenet.api.admin.AddOn

accessImportDataStream, accessPostImportScriptStream, accessPreImportScriptStream, get_AddOnType, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Prerequisites, get_ScriptType, get_SupersededAddOnIds, set_AddOnType, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Prerequisites, set_ScriptType, set_SupersededAddOnIds, setImportDataStream, setPostImportScriptStream, setPreImportScriptStream

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_FromVersions

IdList get_FromVersions()

Returns the value of the FromVersions property. For more information, see FromVersions Property.

set_FromVersions

void set_FromVersions(IdList value)

Sets the value of the FromVersions property. For more information, see FromVersions Property.

get_ToVersions

IdList get_ToVersions()

Returns the value of the ToVersions property. For more information, see ToVersions Property.

set_ToVersions

void set_ToVersions(IdList value)

Sets the value of the ToVersions property. For more information, see ToVersions Property.