portal.dictionary
Interface I_PortalDictionary

All Known Implementing Classes:

A_PortalDictionary

public interface I_PortalDictionary

A dictionary is a facility that delivers objects of any kind to OpenVend.

Each dictionary may deliver different kinds of objects. Dictionaries are chained. When OpenVend tries to load an object from the dictionary, it visits each dictionary in the chain and tries to load the desired object, until it can be deliverd by the current dictionary.

Dictionary objects are type safe. To read an object of a specified type, several readers can be plugged into a dictionary.

Version:

$Revision: 1.7 $

Author:

Thomas Weckert

See Also:

PortalShell.readDictionaryObject(I_PortalDictionaryObjectType, String, String)

Method Summary

void	destroy()
I_PortalDictionary	getFirst()
java.lang.String	getId()
I_PortalDictionary	getNext()
java.util.List	getSupportedObjectTypes()
void	init(PortalApplication portalApplication, PortalDictionaryConfiguration dictionaryConfig)
I_PortalDictionaryObject	readObject(I_PortalDictionaryObjectType type, java.lang.String processName, java.lang.String objectName)
void	setFirst(I_PortalDictionary dictionary)
void	setNext(I_PortalDictionary dictionary)

Method Detail

getId

public java.lang.String getId()

getFirst

public I_PortalDictionary getFirst()

getNext

public I_PortalDictionary getNext()

setFirst

public void setFirst(I_PortalDictionary dictionary)

setNext

public void setNext(I_PortalDictionary dictionary)

init

public void init(PortalApplication portalApplication,
                 PortalDictionaryConfiguration dictionaryConfig)
          throws PortalException

Throws:

PortalException

destroy

public void destroy()
             throws PortalException

Throws:

PortalException

readObject

public I_PortalDictionaryObject readObject(I_PortalDictionaryObjectType type,
                                           java.lang.String processName,
                                           java.lang.String objectName)
                                    throws PortalException

Throws:

PortalException

getSupportedObjectTypes

public java.util.List getSupportedObjectTypes()