com.brightech.mb.workflow.js

Class JSVersionManager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSVersionManager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable

public class JSVersionManager
extends JSBaseScriptableObject

Provides access to VersionManager from javascript objects. Is available in workflow context pre-initialized as "versionManager"

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSVersionManager()

Method Summary

Modifier and Type	Method and Description
void	jsFunction_createNewVersion(int theSourceAssetId, IFileObject theNewVersion, java.lang.String theComment, boolean theIsReplaceName, boolean theIsReplaceMetadata) Copy theSourceAsset to the Versions folder, rename with version, and refresh the droplet in memory with new information.
int	jsFunction_getVersionCount(int theAssetId, java.lang.String theRootDirectory, org.mozilla.javascript.NativeArray theCategoriesArray) Returns the number of versions for the specified asset, root directory, and version categories.
ManagedFile[]	jsFunction_getVersions(int theAssetId, org.mozilla.javascript.NativeArray theCategoriesArray, int theVersionsMax) Returns the assets that are versions for the specified asset, root directory, and version categories.
void	jsFunction_makeVersionOf(int theParentAssetId, int theChildAssetId, java.lang.String theVersionName) Link the two assets as if one is a version of the other.

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

JSVersionManager

public JSVersionManager()

Method Detail

jsFunction_getVersionCount

public int jsFunction_getVersionCount(int theAssetId,
                                      java.lang.String theRootDirectory,
                                      org.mozilla.javascript.NativeArray theCategoriesArray)

Returns the number of versions for the specified asset, root directory, and version categories. The returned count excludes the specified asset. However, it does not exclude duplicates, if an asset is of more than one type of version category.

Parameters:

theAssetId - the specified asset's asset id

theRootDirectory - the root directory (commonly "")

theCategoriesArray - a string array of version categories: "Peers", "Named", "Parents", "Children", "Self"

Returns:

the number of versions

jsFunction_getVersions

public ManagedFile[] jsFunction_getVersions(int theAssetId,
                                            org.mozilla.javascript.NativeArray theCategoriesArray,
                                            int theVersionsMax)

Returns the assets that are versions for the specified asset, root directory, and version categories. The returned array excludes the specified asset and duplicates, if an asset is of more than one type of version category. (This differs from getVersionCount which does not exclude duplicates.)

Parameters:

theAssetId - the specified asset's asset id

theCategoriesArray - a string array of version categories: "Peers", "Named", "Parents", "Children", "Self"

theVersionsMax - the maximum number of versions to return

Returns:

the assets that are versions of theAssetId

jsFunction_makeVersionOf

public void jsFunction_makeVersionOf(int theParentAssetId,
                                     int theChildAssetId,
                                     java.lang.String theVersionName)

Link the two assets as if one is a version of the other. This is the code called when a new version is created, or an asset is checked in

Parameters:

theParentAssetId - the "primary" asset

theChildAssetId - the "child" asset

theVersionName - what is the version called?

jsFunction_createNewVersion

public void jsFunction_createNewVersion(int theSourceAssetId,
                                        IFileObject theNewVersion,
                                        java.lang.String theComment,
                                        boolean theIsReplaceName,
                                        boolean theIsReplaceMetadata)

Copy theSourceAsset to the Versions folder, rename with version, and refresh the droplet in memory with new information.

Parameters:

theSourceAssetId - the current version id