com.ibm.designer.domino.scripting.api.published
Class DesignerPublishedObject

java.lang.Object
  com.ibm.designer.domino.scripting.api.published.DesignerPublishedObject

All Implemented Interfaces:

IScriptData.PublishedObject

Direct Known Subclasses:

XmlPublishedObject

public class DesignerPublishedObject
extends java.lang.Object
implements IScriptData.PublishedObject

A default implementation of IScriptData.PublishedObject. Clients should extend this implementation rather than directly implementing IScriptData.PublishedObject.

Since:

8.5.3

See Also:

IScriptData.PublishedObject

Field Summary

static java.lang.String	PROPERTY_DEFAULTBINDING PROPERTY_DEFAULTBINDING - When this property is requested the tooling typically expects the name of the language that is used as the default databinding 'language' for this particular data source type.
static java.lang.String	PROPERTY_JAVASCRIPT_TYPE JAVASCRIPT_TYPE.
static java.lang.String	PROPERTY_METHODS PROPERTY_METHODS.
static java.lang.String	PROPERTY_NODE String PROPERTY_NODE.
static java.lang.String	PROPERTY_PROJECT PROPERTY_PROJECT - When this property is requested the tooling typically expects an instance of com.ibm.designer.domino.ide.resources.extensions.DesignerProject to be returned.
static java.lang.String	PROPERTY_TAGLOCALNAME PROPERTY_TAGLOCALNAME - When this property is requested the tooling typically expects the Element's local tag name to be returned.
static java.lang.String	PROPERTY_TAGNAMESPACEURI PROPERTY_TAGNAMESPACEURI - When this property is requested the tooling typically expects the Elements namespace URI to be returned.
static java.lang.String	PROPERTY_XMLDEFINITION PROPERTY_XMLDEFINITION.

Constructor Summary

DesignerPublishedObject(java.lang.String name)
Constructs a new instance of this class.

Method Summary

java.lang.String	getName()
org.w3c.dom.Node	getNode()
java.lang.Object	getProperty(java.lang.String propertyName) Used to retrieve information about the data source.
XmlDefinition	getXmlDefinition() returns an XmlDefinition object that is the xml representation of this data source.
boolean	isAdvanced() Indicates to the tooling that this is an advanced data source
void	setName(java.lang.String name) Sets the name of the current PublishedObject.
void	setNode(org.w3c.dom.Node node)
void	setProject(DesignerProject project) Utility method that inserts the current DesignerProject into the property map associated with this data source.
void	setProperty(java.lang.String key, java.lang.Object value) Adds properties to a map, these properties can later be retrieved by calling getProperty(String).

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PROJECT

public static final java.lang.String PROPERTY_PROJECT

PROPERTY_PROJECT - When this property is requested the tooling typically expects an instance of com.ibm.designer.domino.ide.resources.extensions.DesignerProject to be returned.

See Also:

Constant Field Values

PROPERTY_TAGLOCALNAME

public static final java.lang.String PROPERTY_TAGLOCALNAME

PROPERTY_TAGLOCALNAME - When this property is requested the tooling typically expects the Element's local tag name to be returned. e.g. if the current tag name is xp:dominoView, the tooling would expect 'dominoView' to be returned as the local name.

See Also:

Constant Field Values

PROPERTY_TAGNAMESPACEURI

public static final java.lang.String PROPERTY_TAGNAMESPACEURI

PROPERTY_TAGNAMESPACEURI - When this property is requested the tooling typically expects the Elements namespace URI to be returned.

See Also:

Constant Field Values

PROPERTY_DEFAULTBINDING

public static final java.lang.String PROPERTY_DEFAULTBINDING

PROPERTY_DEFAULTBINDING - When this property is requested the tooling typically expects the name of the language that is used as the default databinding 'language' for this particular data source type. e.g 'xpath'

See Also:

Constant Field Values

PROPERTY_NODE

public static final java.lang.String PROPERTY_NODE

String PROPERTY_NODE. When this property is requested the tooling typically expects a Node to be returned. The Node returned should be the node representation of the tag that defines this data source.

See Also:

Constant Field Values

PROPERTY_XMLDEFINITION

public static final java.lang.String PROPERTY_XMLDEFINITION

PROPERTY_XMLDEFINITION. When this property is requested the tooling typically expects an instance of com.ibm.commons.xsd.xml.XmlDefinition to be returned.

See Also:

com.ibm.designer.domino.scripting.api.IScriptData#XML_DOCUMENT} {@link com.ibm.commons.xsd.xml.XmlDefinition}, Constant Field Values

PROPERTY_JAVASCRIPT_TYPE

public static final java.lang.String PROPERTY_JAVASCRIPT_TYPE

JAVASCRIPT_TYPE. When this property is requested the tooling expect an instance of com.ibm.jscript.types.FBSType to be returned. FBSType is a javascript wrapper for an object.

See Also:

IScriptData.JAVASCRIPT_TYPE, Constant Field Values

PROPERTY_METHODS

public static final java.lang.String PROPERTY_METHODS

PROPERTY_METHODS. When this property is requested the tooling typically expects a map of type Map returned. The map should contain method name and method signature pairs. The methods will be displayed in the reference view of the script editor when the current data source is selected.

See Also:

Constant Field Values

Constructor Detail

DesignerPublishedObject

public DesignerPublishedObject(java.lang.String name)

Constructs a new instance of this class.

Parameters:

name - the name of the data source

Method Detail

getNode

public org.w3c.dom.Node getNode()

Returns:

returns the DOM node that corresponds to the data source that this PublishedObject represents.

setNode

public void setNode(org.w3c.dom.Node node)

Parameters:

node - sets the DOM node that corresponds to the data source that this PublishedObject represents.

getName

public java.lang.String getName()

Specified by:

getName in interface IScriptData.PublishedObject

Returns:

returns a string that represents the name of the Data source that is represented by this PublishedObject. In most cases this name will correspond with the var attribute of the data source.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Description copied from interface: IScriptData.PublishedObject

Used to retrieve information about the data source. The PublishedObject implementation will typically implement this as a map lookup. See DesignerPublishedObject for a list of properties that are normally published about the data source. Clients should not implement this interface directly but should instead use the default Domino Designer implementation of the interface. DesignerPublishedObject

Specified by:

getProperty in interface IScriptData.PublishedObject

Parameters:

propertyName - a string that is used as a key to look up a map of objects.

Returns:

java.lang.Object

See Also:

DesignerPublishedObject

getXmlDefinition

public XmlDefinition getXmlDefinition()

returns an XmlDefinition object that is the xml representation of this data source. The XmlDefinition can also be retrieved by calling com.ibm.designer.domino.scripting.api.com.ibm.designer.domino.scripting.api.IScriptData.PublishedObject#getProperty(IScriptData.XML_DOCUMENT)

Returns:

returns an XmlDefinition representing the current data source

See Also:

XmlDefinition

isAdvanced

public boolean isAdvanced()

Description copied from interface: IScriptData.PublishedObject

Indicates to the tooling that this is an advanced data source

Specified by:

isAdvanced in interface IScriptData.PublishedObject

Returns:

boolean

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Adds properties to a map, these properties can later be retrieved by calling getProperty(String).

Parameters:

key - the key used to add the property to the map.

value - a object that the consumer of the DesignerPublishedObject class wishes to retrieve later.

setProject

public void setProject(DesignerProject project)

Utility method that inserts the current DesignerProject into the property map associated with this data source. Identical to calling
setProperty(PROPERTY_PROJECT, project).

Parameters:

project - the current DesignerProject

setName

public void setName(java.lang.String name)

Sets the name of the current PublishedObject.

Parameters:

name -