com.novell.emframe.dev

Class DirPropertyBookPage

java.lang.Object

com.novell.emframe.dev.Plugin

com.novell.emframe.dev.PropertyBookPage

com.novell.emframe.dev.DirPropertyBookPage

public class DirPropertyBookPage
extends PropertyBookPage

Base class used to create PropertyBookPage objects. Most PropertyBookPages will want to extend DirPropertyBookPage instead of just PropertyBookPage to take advantage of eDirectory Access Service features. DirPropertyBookPages extends the PropertyBookPage abstract class so developers only need to overwrite the specific methods they require. See PropertyBookPage for more information on writing PropertyBookPages.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_mooEnabled Whether Multiple Object Operation (Moo) is enabled for this page.
protected MOOManager	m_mooManager MOOManager to use for this page.
protected NSObject	m_nsobj NSObject to use for this page.

Fields inherited from class com.novell.emframe.dev.PropertyBookPage

m_chapter, m_delayedAttributes, m_displayName, m_handledAttributeNames, m_helpfile, m_id, m_IsDirty, m_isXML, m_JSPDataObject, m_pageDoc, m_parameters, m_propertyBook, m_template

Constructor Summary

Constructors

Constructor and Description
DirPropertyBookPage()

Method Summary

Modifier and Type	Method and Description
protected boolean	doesSupportMoo() Returns the default implemenation read value from page xml descriptor.
java.lang.String[]	getAttributesForEDAS(PropertyPageContext context) Default implementation returns all attribute names that the xml descriptor has registered rights for.
DirPropertyBook	getDirPropertyBook() Returns the parent DirPropertyBook object.
void	init(PluginContext context, org.jdom.Document doc) Deprecated. - as of 2.6 use init(TaskContext, Document)
void	init(TaskContext context, org.jdom.Document doc) Initializes the member variables with data from an XML configuration document.
void	save(TaskContext context, java.util.Properties resultStrings) Deprecated. Use cache(PropertyPageContext context) instead
void	show(TaskContext context, java.util.Properties resultStrings) Deprecated. Use show(PropertyPageContext context) instead

Methods inherited from class com.novell.emframe.dev.PropertyBookPage

apply, cache, canCommit, canCommit, commit, getChapter, getDelayedAttributes, getHandledAttributeNames, getHelpFilename, getId, getName, getTemplate, release, setChapter, shouldRun, show

Methods inherited from class com.novell.emframe.dev.Plugin

isPluginAvailable, isPluginAvailable

Methods inherited from class java.lang.Object

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

Field Detail

m_nsobj

protected NSObject m_nsobj

NSObject to use for this page.

m_mooManager

protected MOOManager m_mooManager

MOOManager to use for this page.

m_mooEnabled

protected boolean m_mooEnabled

Whether Multiple Object Operation (Moo) is enabled for this page.

Constructor Detail

DirPropertyBookPage

public DirPropertyBookPage()

Method Detail

getDirPropertyBook

public DirPropertyBook getDirPropertyBook()

Returns the parent DirPropertyBook object.

Returns:

DirPropertyBook containing a reference to parent book

init

public void init(TaskContext context,
                 org.jdom.Document doc)

Initializes the member variables with data from an XML configuration document.

Overrides:

init in class Plugin

Parameters:

context - PluginContext of the plug-in

doc - XML Document registering this page

init

public void init(PluginContext context,
                 org.jdom.Document doc)

Deprecated. - as of 2.6 use init(TaskContext, Document)

Initializes the member variables with data from an XML configuration document.

Overrides:

init in class PropertyBookPage

Parameters:

context - PluginContext of the plug-in

doc - XML Document registering this page

See Also:

Plugin.init(TaskContext, Document)

save

public void save(TaskContext context,
                 java.util.Properties resultStrings)
          throws PageException

Deprecated. Use cache(PropertyPageContext context) instead

Cache the posted data to a temporary data source. Don't write it to eDirectory.

Overrides:

save in class PropertyBookPage

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties object to be added to the request

Throws:

PageException

See Also:

PropertyBookPage.cache(com.novell.emframe.dev.PropertyPageContext)

show

public void show(TaskContext context,
                 java.util.Properties resultStrings)
          throws PageException

Deprecated. Use show(PropertyPageContext context) instead

Read data from cached data-source. Stuff results in xml/properties to be rendered.

Overrides:

show in class PropertyBookPage

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties object to be added to the request

Throws:

PageException

See Also:

show(com.novell.emframe.dev.TaskContext, java.util.Properties)

doesSupportMoo

protected boolean doesSupportMoo()

Returns the default implemenation read value from page xml descriptor.

Returns:

boolean: true if this page supports Multiple Object Operations using a MOOManager, false if otherwise

getAttributesForEDAS

public java.lang.String[] getAttributesForEDAS(PropertyPageContext context)

Default implementation returns all attribute names that the xml descriptor has registered rights for.

Parameters:

context - PropertyPageContext for use for eDias

Returns:

String attribute containing a list of attributes that EDAS will read and localize