com.brightech.mb.workflow.js

Class JSRssFeedManager

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

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

RSS Feed Manager for javascript (workflows). Is available in workflow context pre-initialized as "rssFeedManager" Note: RSS events are not triggered by ManagedFile.writeXmp(). This manager allows workflows to trigger RSS events by doing so directly.

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	(JavaScript Function) createDirectoryFeed(java.lang.String theDirectory, java.lang.String theName, java.lang.String theDescription, boolean theShowComments, boolean theShowMetadata, boolean theShowPreview, boolean theShowLink, boolean theShowDescription, boolean theIsLocked, boolean theIsFullAccess, int theEvents, java.lang.String theXmpFields)
java.lang.String	(JavaScript Function) createSelectionFeed(int theSelectionId, java.lang.String theName, java.lang.String theDescription, boolean theShowComments, boolean theShowMetadata, boolean theShowPreview, boolean theShowLink, boolean theShowDescription, boolean theIsLocked, boolean theIsFullAccess, int theEvents, java.lang.String theXmpFields)
java.lang.String	(JavaScript Function) getFeedName(java.lang.String theFeedId) Get the feed name from the feed id
void	(JavaScript Function) submitMetadataChangeEvent(int theAssetId, java.lang.String theUserName, java.lang.String theOldXmpString, java.lang.String theNewXmpString) Submits a RSS metadata change event for the specified asset, user, and old/new XMP.

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

JSRssFeedManager

public JSRssFeedManager()

Method Detail

(JavaScript Function) submitMetadataChangeEvent

public void (JavaScript Function) submitMetadataChangeEvent(int theAssetId,
                                                 java.lang.String theUserName,
                                                 java.lang.String theOldXmpString,
                                                 java.lang.String theNewXmpString)

Submits a RSS metadata change event for the specified asset, user, and old/new XMP. No XMP data is added to the change event if either the old or new XMP data strings is null.

Parameters:

theAssetId - the asset id

theUserName - the username (may be null)

theOldXmpString - the old XMP data string (may be null)

theNewXmpString - the new XMP data string (may be null)

(JavaScript Function) createSelectionFeed

public java.lang.String (JavaScript Function) createSelectionFeed(int theSelectionId,
                                                       java.lang.String theName,
                                                       java.lang.String theDescription,
                                                       boolean theShowComments,
                                                       boolean theShowMetadata,
                                                       boolean theShowPreview,
                                                       boolean theShowLink,
                                                       boolean theShowDescription,
                                                       boolean theIsLocked,
                                                       boolean theIsFullAccess,
                                                       int theEvents,
                                                       java.lang.String theXmpFields)

Parameters:

theSelectionId - selection id

theName - name of feed

theDescription - description for feed

theShowComments - show comments in feed

theShowMetadata - show metadata in feed

theShowPreview - show preview in feed

theShowLink - show link in feed

theShowDescription - show event description

theIsLocked - is locked

theIsFullAccess - is feed full access (asset feeds)

theEvents - Integer bitmask with each event added together. If want that event use the number. If do not, use a 0. Add all types into one integer and pass into function: kFILE_CHANGES = 1, kMETADATA_CHANGES = 2, kCOMMENTS = 4, kNEW_FILE = 8, kDOWNLOAD_FILE = 16

theXmpFields - comma separated list of field ids

(JavaScript Function) createDirectoryFeed

public java.lang.String (JavaScript Function) createDirectoryFeed(java.lang.String theDirectory,
                                                       java.lang.String theName,
                                                       java.lang.String theDescription,
                                                       boolean theShowComments,
                                                       boolean theShowMetadata,
                                                       boolean theShowPreview,
                                                       boolean theShowLink,
                                                       boolean theShowDescription,
                                                       boolean theIsLocked,
                                                       boolean theIsFullAccess,
                                                       int theEvents,
                                                       java.lang.String theXmpFields)

Parameters:

theDirectory - directory path to listen to

theName - name of feed

theDescription - description for feed

theShowComments - show comments in feed

theShowMetadata - show metadata in feed

theShowPreview - show preview in feed

theShowLink - show link in feed

theShowDescription - show event description

theIsLocked - is locked

theIsFullAccess - is feed full access (asset feeds)

theEvents - Integer bitmask with each event added together. If want that event use the number. If do not, use a 0. Add all types into one integer and pass into function: kFILE_CHANGES = 1, kMETADATA_CHANGES = 2, kCOMMENTS = 4, kNEW_FILE = 8, kDOWNLOAD_FILE = 16

theXmpFields - comma separated list of field ids

(JavaScript Function) getFeedName

public java.lang.String (JavaScript Function) getFeedName(java.lang.String theFeedId)

Get the feed name from the feed id

Parameters:

theFeedId - id of the feed

Returns:

name of the feed