com.brightech.mb.workflow.js

Class JSFieldManager

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

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

Provides access to a field manager to javascript objects. Is available in workflow context pre-initialized as "fieldManager"

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

Method Summary

Modifier and Type	Method and Description
boolean	(JavaScript Function) canEdit(java.lang.String theFieldId, int theEditLevel) Returns true if the field is editable at the specified edit level, otherwise returns false.
boolean	(JavaScript Function) canView(java.lang.String theFieldId, int theViewLevel) Returns true if the field is viewable at the specified view level, otherwise returns false.
PropertyWrapper[]	(JavaScript Function) getAllFields() Get all fields from all schemas.
java.lang.String	(JavaScript Function) getColumn(java.lang.String theFieldSpec) Gets db column name of the specified field
java.lang.String	(JavaScript Function) getContainerTableName(java.lang.String theFieldSpec) Get the name of the table the container field places its values in
PropertyWrapper[]	(JavaScript Function) getFields(java.lang.String theURI) Get fields in the schema with the given URI.
boolean	(JavaScript Function) isContainer(PropertyWrapper theProperty) Is the field a container field?
boolean	(JavaScript Function) isEditable(java.lang.String theFieldId, int theAssetId, int theGroupId) Returns true if the field is editable at the specified group and in the specified asset, otherwise returns false.
boolean	(JavaScript Function) isHierarchical(PropertyWrapper theProperty) Is the field a hierarchy field?
void	(JavaScript Function) updateDictionary(java.lang.String theFieldId, java.lang.String theDictionaryName) Updates the dictionary for the given field.
void	(JavaScript Function) updateValidator(java.lang.String theFieldId, java.lang.String theValidator) Updates the validator for the given field.
void	(JavaScript Function) updateXmpPanels(java.lang.String theFieldId, java.lang.String theDictionaryName) Updates xmp panels for a given field.

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

JSFieldManager

public JSFieldManager()

Method Detail

(JavaScript Function) getColumn

public java.lang.String (JavaScript Function) getColumn(java.lang.String theFieldSpec)

Gets db column name of the specified field

Parameters:

theFieldSpec - the field name

Returns:

The DB column name, as a String

(JavaScript Function) getContainerTableName

public java.lang.String (JavaScript Function) getContainerTableName(java.lang.String theFieldSpec)

Get the name of the table the container field places its values in

Parameters:

theFieldSpec - field id

Returns:

table name

(JavaScript Function) getFields

public PropertyWrapper[] (JavaScript Function) getFields(java.lang.String theURI)

Get fields in the schema with the given URI.

Parameters:

theURI - The URI.

Returns:

Fields in the schema with the given URI.

(JavaScript Function) getAllFields

public PropertyWrapper[] (JavaScript Function) getAllFields()

Get all fields from all schemas.

Returns:

Field definitions

(JavaScript Function) isContainer

public boolean (JavaScript Function) isContainer(PropertyWrapper theProperty)

Is the field a container field?

Parameters:

theProperty -

Returns:

(JavaScript Function) isHierarchical

public boolean (JavaScript Function) isHierarchical(PropertyWrapper theProperty)

Is the field a hierarchy field?

Parameters:

theProperty -

Returns:

(JavaScript Function) canView

public boolean (JavaScript Function) canView(java.lang.String theFieldId,
                                  int theViewLevel)

Returns true if the field is viewable at the specified view level, otherwise returns false.

Parameters:

theFieldId - the field id.

theViewLevel - the view level.

Returns:

true if viewable, false if not.

(JavaScript Function) canEdit

public boolean (JavaScript Function) canEdit(java.lang.String theFieldId,
                                  int theEditLevel)

Returns true if the field is editable at the specified edit level, otherwise returns false.

Parameters:

theFieldId - the field id.

theEditLevel - the edit level.

Returns:

true if editable, false if not.

(JavaScript Function) isEditable

public boolean (JavaScript Function) isEditable(java.lang.String theFieldId,
                                     int theAssetId,
                                     int theGroupId)

Returns true if the field is editable at the specified group and in the specified asset, otherwise returns false.

Parameters:

theFieldId - the field id.

theAssetId - the asset id.

theGroupId - the group id.

Returns:

true if the field is editable, false otherwise.

(JavaScript Function) updateValidator

public void (JavaScript Function) updateValidator(java.lang.String theFieldId,
                                       java.lang.String theValidator)

Updates the validator for the given field.

Parameters:

theFieldId - the field id

theValidator - the validator

(JavaScript Function) updateDictionary

public void (JavaScript Function) updateDictionary(java.lang.String theFieldId,
                                        java.lang.String theDictionaryName)

Updates the dictionary for the given field.

Parameters:

theFieldId - the field id

theDictionaryName - the dictionary name

(JavaScript Function) updateXmpPanels

public void (JavaScript Function) updateXmpPanels(java.lang.String theFieldId,
                                       java.lang.String theDictionaryName)

Updates xmp panels for a given field.

Parameters:

theFieldId - the field id

theDictionaryName - the dictionary name