org.sape.carbon.core.config.node.link
Interface LinkNode

All Superinterfaces:

Node

All Known Subinterfaces:

ConfigurationDocumentLink, FolderLink

All Known Implementing Classes:

AbstractLinkNode, ConfigurationDocumentLinkImpl, FolderLinkImpl

public interface LinkNode

extends Node

LinkNodes are Nodes that point to other Nodes within the same or another data store. The primary example is the root Node of the ConfigurationService. It is a LinkNode that points to the location of the root of the configuraiton node graph. This interface contains methods for reading and writing the LinkNodeConfiguration that configures the link. Copyright 2002 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.3 $($Author: dvoet $ / $Date: 2003/05/05 21:21:19 $)

Author:

Douglas Voet, March 2002

Field Summary

Fields inherited from interface org.sape.carbon.core.config.node.Node

DELIMITER

Method Summary

LinkNodeConfiguration	readLinkConfiguration() Reads the LinkNodeConfiguration object that configures this link
void	writeLinkConfiguration(LinkNodeConfiguration config) Writes a new LinkNodeConfiguration to the backing data store.

Methods inherited from interface org.sape.carbon.core.config.node.Node

addNodeListener, addNodeListener, containsChild, fetchChild, fetchChildren, getAbsoluteName, getAllowsChildren, getName, getParent, isRemoved, refresh, remove

Method Detail

readLinkConfiguration

public LinkNodeConfiguration readLinkConfiguration()
                                            throws NodeIOException,
                                                   ConfigurationFormatException

Reads the LinkNodeConfiguration object that configures this link

Returns:

LinkNodeConfiguration

Throws:

NodeIOException - if there is an exception reading from the backing data store

ConfigurationFormatException - if the configuration has an invalid format

writeLinkConfiguration

public void writeLinkConfiguration(LinkNodeConfiguration config)
                            throws NodeIOException,
                                   ConfigurationFormatException

Writes a new LinkNodeConfiguration to the backing data store. Note that if changing a configuration, changes will not take effect until the ConfigurationService is reloaded. In most cases, that is when the system is restarted.

Parameters:

config - the new LinkNodeConfiguration

Throws:

NodeIOException - if there is an exception writing to the backing data store

ConfigurationFormatException - if there is a problem formatting the data