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

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

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
int	(JavaScript Function) 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[]	(JavaScript Function) 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	(JavaScript Function) 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

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

equals, 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

(JavaScript Function) getVersionCount

public int (JavaScript Function) 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

(JavaScript Function) getVersions

public ManagedFile[] (JavaScript Function) 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

(JavaScript Function) makeVersionOf

public void (JavaScript Function) 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?