com.ibm.designer.domino.scripting.data
Class AbstractScriptData

java.lang.Object
  com.ibm.designer.domino.scripting.data.AbstractScriptData

All Implemented Interfaces:

IScriptData

Direct Known Subclasses:

XSPNodeData

public abstract class AbstractScriptData
extends java.lang.Object
implements IScriptData

Abstract implementation of a script data map that features predefined PublishedObject classes.

Nested Class Summary

static class	AbstractScriptData.DataSourceObject
static class	AbstractScriptData.DesignerObject
static class	AbstractScriptData.JavaScriptObject

Nested classes/interfaces inherited from interface com.ibm.designer.domino.scripting.api.IScriptData

IScriptData.PublishedObject

Field Summary

static java.lang.String	DIRECTORY_LIB
static java.lang.String	DOCDB_LIB
static java.lang.String	DOM_LIB
static java.lang.String	MAIL_LIB
static java.lang.String	RUNTIME_LIB
static java.lang.String	STANDARD_LIB
static java.lang.String	WEBSERVICES_LIB
static java.lang.String	XSP_LIB

Fields inherited from interface com.ibm.designer.domino.scripting.api.IScriptData

HAS_XML_DOCUMENT, JAVA_CLASS, JAVASCRIPT_TYPE, XML_DOCUMENT

Constructor Summary

AbstractScriptData()

Method Summary

protected void	addObjectsToMap(java.util.Map<java.lang.String,IScriptData.PublishedObject> map) Adds PublishedObjects to the given map.
protected abstract void	addPrototypesToMap(java.util.Map<java.lang.String,com.ibm.xsp.javascript.XSPFunctions> map) Allows subclasses to add libraries to the reference tab in the JS Editor.
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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIRECTORY_LIB

public static final java.lang.String DIRECTORY_LIB

See Also:

Constant Field Values

MAIL_LIB

public static final java.lang.String MAIL_LIB

See Also:

Constant Field Values

DOCDB_LIB

public static final java.lang.String DOCDB_LIB

See Also:

Constant Field Values

DOM_LIB

public static final java.lang.String DOM_LIB

See Also:

Constant Field Values

RUNTIME_LIB

public static final java.lang.String RUNTIME_LIB

See Also:

Constant Field Values

STANDARD_LIB

public static final java.lang.String STANDARD_LIB

See Also:

Constant Field Values

WEBSERVICES_LIB

public static final java.lang.String WEBSERVICES_LIB

See Also:

Constant Field Values

XSP_LIB

public static final java.lang.String XSP_LIB

See Also:

Constant Field Values

Constructor Detail

AbstractScriptData

public AbstractScriptData()

Method Detail

getPublishedObjects

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

Description copied from interface: IScriptData

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

Specified by:

getPublishedObjects in interface IScriptData

Returns:

java.util.Map

isLibraryValid

public boolean isLibraryValid(java.lang.String libraryName)

Description copied from interface: IScriptData

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

Specified by:

isLibraryValid in interface IScriptData

Parameters:

libraryName - the qualified name of a library.

Returns:

boolean

getPrototypes

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

Description copied from interface: IScriptData

Returns a map of JavaScript method signatures.

Specified by:

getPrototypes in interface IScriptData

Returns:

addObjectsToMap

protected void addObjectsToMap(java.util.Map<java.lang.String,IScriptData.PublishedObject> map)

Adds PublishedObjects to the given map. Provides PublishedObjectProviders with the opportunity to contribute to the JS editor. Items added to the map via addObjectsToMap will be added to the reference tab of the JS Editor.

Parameters:

map -

addPrototypesToMap

protected abstract void addPrototypesToMap(java.util.Map<java.lang.String,com.ibm.xsp.javascript.XSPFunctions> map)

Allows subclasses to add libraries to the reference tab in the JS Editor.

Parameters:

map - a map containing the name of the library as the key, and a list of functions as the key.

isPageData

public boolean isPageData()

Specified by:

isPageData in interface IScriptData

Returns:

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