com.ibm.designer.domino.scripting.api
Interface IScriptData

All Known Implementing Classes:

AbstractScriptData, XSPNodeData

public interface IScriptData

This interface defines the data passed to a script editor, and also the information made available through the data tooling for an XPage. This interface is passed from the caller to the script editor in order to feed the different parts (code completion, reference list....). It returns instances of PublishedObject. These objects are loosely coupled to data and can adapt to different context. For example, an XML datasource object can make available a javascript object (document) but also an XSD schema (also called document) for an XPath/XPage editor.

Since:

8.5.3

Nested Class Summary

static interface

IScriptData.PublishedObject A PublishedObject is loosely coupled to data and can adapt to different contexts.

Field Summary

static java.lang.String	HAS_XML_DOCUMENT
static java.lang.String	JAVA_CLASS JAVA_CLASS - A property used by the JavaScript editor code for determining the Java type for this data source.
static java.lang.String	JAVASCRIPT_TYPE JAVASCRIPT_TYPE - A property used by content assist in the JavaScript editor when distinguishing a type for the current data source.
static java.lang.String	XML_DOCUMENT XML_DOCUMENT - A property used extensively throughout the entire data tooling framework.

Method Summary

java.util.Map<java.lang.String,com.ibm.xsp.javascript.XSPFunctions>	getPrototypes() Returns a map of JavaScript method signatures.
java.util.Map<java.lang.String,IScriptData.PublishedObject>	getPublishedObjects() Returns a map of PublishedObjects that are relevant to the current IScriptData
boolean	isLibraryValid(java.lang.String libraryName) Given a library name this method calculates if the specified library is relevant to the IScriptData.
boolean	isPageData()

Field Detail

JAVASCRIPT_TYPE

static final java.lang.String JAVASCRIPT_TYPE

JAVASCRIPT_TYPE - A property used by content assist in the JavaScript editor when distinguishing a type for the current data source.

See Also:

Constant Field Values

JAVA_CLASS

static final java.lang.String JAVA_CLASS

JAVA_CLASS - A property used by the JavaScript editor code for determining the Java type for this data source.

See Also:

Constant Field Values

XML_DOCUMENT

static final java.lang.String XML_DOCUMENT

XML_DOCUMENT - A property used extensively throughout the entire data tooling framework. When the PublishedObject is queried for this property it typically means that the data tooling is trying to calculate the data that is published to the JSF data model by the tag that this PublishedObject represents.

When queried for this property the PublishedObject must return an object of type XmlDefinition

See Also:

Constant Field Values

HAS_XML_DOCUMENT

static final java.lang.String HAS_XML_DOCUMENT

See Also:

Constant Field Values

Method Detail

getPublishedObjects

java.util.Map<java.lang.String,IScriptData.PublishedObject> getPublishedObjects()

Returns a map of PublishedObjects that are relevant to the current IScriptData

Returns:

java.util.Map

isLibraryValid

boolean isLibraryValid(java.lang.String libraryName)

Given a library name this method calculates if the specified library is relevant to the IScriptData.

Parameters:

libraryName - the qualified name of a library.

Returns:

boolean

getPrototypes

java.util.Map<java.lang.String,com.ibm.xsp.javascript.XSPFunctions> getPrototypes()

Returns a map of JavaScript method signatures.

Returns:

isPageData

boolean isPageData()

Returns:

true or false depending on whether or not this data object is created based on data in an XPage