Domino Designer Published Object Provider

Identifier:

com.ibm.designer.domino.scripting.publishedProvider

Since:

Domino Designer 8.5.2

Description:

This extension point is used to contribute additional data tooling information to Domino Designer. When selection is placed in an XPage the data tooling framework within Domino Designer searches through the tag hierarchy and calculates what data objects are visible to the currently selected tag based on the hierarchy. If a particular XSP tag can contribute data to the JSF model then it should contribute a PublishedObject and a PublishedObjectProvider to Domino Designer in order for Domino Designer to be able to make that data information available within the tooling. When selection is placed within an XPage the XPage editor queries the PublishedObjectProvider registry to see if a PublishedObjectProvider has been contributed for any of the tags in the hierarchy of the XPage. If a tag on the XPage has contributed a PublishedObjectProvider then the provider is queried for certain information.

Configuration Markup:

<!ELEMENT extension (published+)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT published EMPTY>

<!ATTLIST published

id CDATA #REQUIRED

provider CDATA #REQUIRED

Defines an object that can provide Data to the JSF/XPages Data Model.

id - A unique id used to identify this provider.
provider - This attribute specifies a fully qualified class name. The class must implement com.ibm.designer.domino.scripting.api.published.PublishedObjectProvider. The PublishedObjectProvider is responsible for providing a new instance of com.ibm.designer.domino.scripting.api.IScriptData.PublishedObject based on the current context.

Examples:

The following example shows to contribute a PublishedObjectProvider using the extension point framework. In this case the class com.myco.myproduct.myplugin.mypackage.published.MyDataSourceProvider will be queried for PublishedObjects each time selection changes in the XPages editor. It is up to the class com.myco.myproduct.myplugin.mypackage.published.MyDataSourceProvider to determine if a PublishedObect should be contributed based on selections.


<extension
        point="com.ibm.designer.domino.scripting.publishedProvider">
     <published
           id="myDataSource"
           provider="com.myco.myproduct.myplugin.mypackage.published.MyDataSourceProvider"/>
 </extension>