com.brightech.mb.workflow.js

Class JSCheckoutManager

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.JSCheckoutManager

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 JSCheckoutManager
extends JSBaseScriptableObject

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 com.brightech.xmp.js.ReleasableScriptableObject

myLogger

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
JSCheckoutManager()

Method Summary

Modifier and Type	Method and Description
boolean	jsFunction_cancelCheckout(ManagedFile theFile) Remove PWC and unlock the asset.
boolean	jsFunction_checkinWithPresignedURL(ManagedFile theOriginalFile, java.lang.String theObjectKey, java.lang.String theComment, boolean theReplaceName, boolean theReplaceMetadata)
boolean	jsFunction_checkinWorkingCopy(ManagedFile theFile, java.lang.String theComment, IFileObject theUploadFile, boolean theReplaceName, boolean theReplaceMetadata) Check in the Working Copy as a new version of the asset.
int	jsFunction_checkout(ManagedFile theFile) Check out the asset, creating a Private Working Copy (PWC) for editing.
org.mozilla.javascript.NativeArray	jsFunction_getVersionAssetIds(int theAssetId) get a list of versions including the current
int	jsFunction_getWorkingCopyId(ManagedFile theFile) Get the ID of the working copy, for editing, etc.

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

JSCheckoutManager

public JSCheckoutManager()

Method Detail

jsFunction_checkout

public int jsFunction_checkout(ManagedFile theFile)

Check out the asset, creating a Private Working Copy (PWC) for editing.

Parameters:

theFile - the file to check out.

Returns:

ID of Working Copy asset.

jsFunction_cancelCheckout

public boolean jsFunction_cancelCheckout(ManagedFile theFile)

Remove PWC and unlock the asset.

Parameters:

theFile - the file to cancel check out.

Returns:

true on success, false if an error occurred.

jsFunction_checkinWorkingCopy

public boolean jsFunction_checkinWorkingCopy(ManagedFile theFile,
                                             java.lang.String theComment,
                                             IFileObject theUploadFile,
                                             boolean theReplaceName,
                                             boolean theReplaceMetadata)

Check in the Working Copy as a new version of the asset.

Parameters:

theFile - the file that will get the PWC as a new version.

theComment - a description of the change.

theUploadFile - the file that will replace the original

Returns:

true on success, false if an error occurred.

jsFunction_checkinWithPresignedURL

public boolean jsFunction_checkinWithPresignedURL(ManagedFile theOriginalFile,
                                                  java.lang.String theObjectKey,
                                                  java.lang.String theComment,
                                                  boolean theReplaceName,
                                                  boolean theReplaceMetadata)

jsFunction_getWorkingCopyId

public int jsFunction_getWorkingCopyId(ManagedFile theFile)

Get the ID of the working copy, for editing, etc.

Returns:

ID of the working copy, or -1 if asset not checked out or no PWC available.

jsFunction_getVersionAssetIds

public org.mozilla.javascript.NativeArray jsFunction_getVersionAssetIds(int theAssetId)

get a list of versions including the current

Parameters:

theAssetId - the current id

Returns:

the list of ids