com.plumtree.remote.sci
Interface IAdminEditor

public interface IAdminEditor

Root interface for the SCI editor. Allows you to create Service Configuration pages that plug into portal editors.

Method Summary

NamedValue[]	finalize(NamedValueMap pageInfo) Makes any final changes before storage.
IAdminPage[]	getPages() Gets the editor pages.
void	initialize(java.lang.String locale, TypeNamespace namespace, NamedValueMap parentInfo) Sets up the editor and processes any existing settings.

Method Detail

getPages

public IAdminPage[] getPages()
                      throws ServiceException

Gets the editor pages. Calls to getContent and validate are done through IAdminPage.

Returns:

an IAdminPage array of editor pages

Throws:

ServiceException - if a SOAP error occurs

See Also:

IAdminPage

initialize

public void initialize(java.lang.String locale,
                       TypeNamespace namespace,
                       NamedValueMap parentInfo)
                throws ServiceException

Sets up the editor and processes any existing settings.

Parameters:

locale - the user's locale

namespace - the TypeNamespace for the editor page (crawler, search, etc.)

parentInfo - null for all editors that do not have a parent (all editors except for crawlers). For crawlers, incoming NamedValueMap from the portal contains all the values provided in finalize from the data source. Note: The names in NamedValues are converted to uppercase by the portal.

Throws:

ServiceException - if a SOAP error occurs

finalize

public NamedValue[] finalize(NamedValueMap pageInfo)
                      throws ServiceException

Makes any final changes before storage. Any additional NamedValues added during finalize will be stored as TypeStorage.STRING. All names in NamedValuesare converted to uppercase by the portal.

Parameters:

pageInfo - the incoming NamedValueMap of editor settings

Returns:

a NamedValueMap array of settings to be stored in the portal.

Throws:

ServiceException - if a SOAP error occurs