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

public class JSCheckoutManager
extends JSBaseScriptableObject

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

Method Summary

Modifier and Type	Method and Description
boolean	(JavaScript Function) cancelCheckout(ManagedFile theFile) Remove PWC and unlock the asset.
boolean	(JavaScript Function) checkinWorkingCopy(ManagedFile theFile, java.lang.String theComment, IFileObject theUploadFile) Check in the Working Copy as a new version of the asset.
int	(JavaScript Function) checkout(ManagedFile theFile) Check out the asset, creating a Private Working Copy (PWC) for editing.
int	(JavaScript Function) getWorkingCopyId(ManagedFile theFile) Get the ID of the working copy, for editing, etc.

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

JSCheckoutManager

public JSCheckoutManager()

Method Detail

(JavaScript Function) checkout

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

(JavaScript Function) cancelCheckout

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

(JavaScript Function) checkinWorkingCopy

public boolean (JavaScript Function) checkinWorkingCopy(ManagedFile theFile,
                                             java.lang.String theComment,
                                             IFileObject theUploadFile)

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.

(JavaScript Function) getWorkingCopyId

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