com.brightech.mb.workflow.js

Class JSLinkManager

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

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

Exposes the link management api to rhino javascript. Is available in workflow context pre-initialized as "linkManager"

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

Method Summary

Modifier and Type	Method and Description
JSLink	(JavaScript Function) addToLinkGroup(ManagedFile theFile, ManagedFile theFile2, java.lang.Boolean theDirectional, java.lang.String theDescription, java.lang.String theLinkGroupId) Add the second given asset to the first given asset's link group identified by the given link group id.
JSLink	(JavaScript Function) createLink(ManagedFile theAsset, ManagedFile theAsset2, java.lang.Boolean theDirectional, java.lang.String theDescription) Create a link between the given assets.
JSLink	(JavaScript Function) createLinkById(java.lang.Integer theAssetId, java.lang.Integer theAssetId2, java.lang.Boolean theDirectional, java.lang.String theDescription) Create a link between the given assets.
JSLink	(JavaScript Function) createLinksByResolver(java.lang.String theResolverUrl, java.lang.String theGlobalDescription, Parameters theIndividualDescriptions) Create links between the given assets.
ManagedFile[]	(JavaScript Function) getAssetsInLinkGroup(ManagedFile theAsset, JSLink theLinkGroup) Get the other assets linked to the given asset by the given link group.
ManagedFile[]	(JavaScript Function) getLinkedAssets(java.lang.Integer theAssetId) Get assets linked to the given asset.
JSLink[]	(JavaScript Function) getLinks(java.lang.Integer theAssetId) Get a given asset's template links which define which assets are linked to the given asset.
JSLink	(JavaScript Function) linkAssetWithResolver(java.lang.Integer theAssetId, java.lang.String theResolverUrl, java.lang.String theGlobalDescription, Parameters theIndividualDescriptions) Links an asset to each asset defined by a resolver
void	(JavaScript Function) removeFromLinkGroup(ManagedFile theAsset, JSLink theLinkGroup) Remove the given asset from the given link group.

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

JSLinkManager

public JSLinkManager()

Method Detail

(JavaScript Function) createLink

public JSLink (JavaScript Function) createLink(ManagedFile theAsset,
                                    ManagedFile theAsset2,
                                    java.lang.Boolean theDirectional,
                                    java.lang.String theDescription)

Create a link between the given assets.

Parameters:

theAsset - An asset to link.

theAsset2 - An asset to link.

theDirectional - Is the link directional? If true will only link from asset 1 to asset 2.

theDescription - The link description.

Returns:

the link

(JavaScript Function) createLinksByResolver

public JSLink (JavaScript Function) createLinksByResolver(java.lang.String theResolverUrl,
                                               java.lang.String theGlobalDescription,
                                               Parameters theIndividualDescriptions)

Create links between the given assets.

Parameters:

theResolverUrl - the resolver url

theGlobalDescription - the global link description

theIndividualDescriptions - the individual descriptions (optional)

Returns:

the link

(JavaScript Function) linkAssetWithResolver

public JSLink (JavaScript Function) linkAssetWithResolver(java.lang.Integer theAssetId,
                                               java.lang.String theResolverUrl,
                                               java.lang.String theGlobalDescription,
                                               Parameters theIndividualDescriptions)

Links an asset to each asset defined by a resolver

Parameters:

theAssetId -

theResolverUrl -

theGlobalDescription -

theIndividualDescriptions -

Returns:

(JavaScript Function) createLinkById

public JSLink (JavaScript Function) createLinkById(java.lang.Integer theAssetId,
                                        java.lang.Integer theAssetId2,
                                        java.lang.Boolean theDirectional,
                                        java.lang.String theDescription)

Create a link between the given assets.

Parameters:

theAssetId - An asset to link.

theAssetId2 - An asset to link.

theDirectional - Is the link directional? If true will only link from asset 1 to asset 2.

theDescription - The link description.

Returns:

the link

(JavaScript Function) addToLinkGroup

public JSLink (JavaScript Function) addToLinkGroup(ManagedFile theFile,
                                        ManagedFile theFile2,
                                        java.lang.Boolean theDirectional,
                                        java.lang.String theDescription,
                                        java.lang.String theLinkGroupId)

Add the second given asset to the first given asset's link group identified by the given link group id.

Parameters:

theFile - The asset being linked to.

theFile2 - The linking asset.

theDirectional - Is this a directional link?

theDescription - The link description

theLinkGroupId - The link group id.

Returns:

the link

(JavaScript Function) removeFromLinkGroup

public void (JavaScript Function) removeFromLinkGroup(ManagedFile theAsset,
                                           JSLink theLinkGroup)

Remove the given asset from the given link group.

Parameters:

theAsset - The given asset.

theLinkGroup - The id of the link group to be deleted.

(JavaScript Function) getLinkedAssets

public ManagedFile[] (JavaScript Function) getLinkedAssets(java.lang.Integer theAssetId)

Get assets linked to the given asset.

Parameters:

theAssetId - the given asset.

Returns:

Asset linked to the given asset.

(JavaScript Function) getAssetsInLinkGroup

public ManagedFile[] (JavaScript Function) getAssetsInLinkGroup(ManagedFile theAsset,
                                                     JSLink theLinkGroup)

Get the other assets linked to the given asset by the given link group.

Parameters:

theAsset - The given asset.

theLinkGroup - The given link group to find the other members of.

Returns:

The other assets in the given link group.

(JavaScript Function) getLinks

public JSLink[] (JavaScript Function) getLinks(java.lang.Integer theAssetId)

Get a given asset's template links which define which assets are linked to the given asset. This method doesn't return the asset that are actually linked to the given asset.

Parameters:

theAssetId - The given asset.

Returns:

The given asset's links.