oracle.panama.feed
Interface PassThroughDataFeeder

All Superinterfaces:

ModelObject, XMLObject

All Known Subinterfaces:

DataFeeder

public interface PassThroughDataFeeder

extends ModelObject

Fields inherited from interface oracle.panama.model.ModelObject

TYPEID

Method Summary

Type	Method
void	addInputParameters(FeedMetaData[] param) Set the meta data for this Content Store.
void	addOutputParameters(FeedMetaData[] param) set the meta data for this Content Store.
void	createFeedDefinition() Create the feed definition -- this will register the Input/Output parameters with the alert framework and create the cache table if needed.
FeedMetaData	createMetaData(java.lang.String name, java.lang.String type) Create a FeedMetaData instance, for use with add{Input,Output}Parameter
java.lang.String	getClassName() Get the name of the class implementing this datafeeder For the 'standard' DataFeeder this will be null
java.util.Map[]	getData(java.util.Map params) Retrieve the data feed from application's feed table for a given set of parameters.
FeedMetaData	getInputParameter(java.lang.String paramName) Get a named input parameter.
FeedMetaData[]	getInputParameters() Get the meta data for this Content Store.
java.lang.String	getName() Get the name of the underlying feed
FeedMetaData	getOutputParameter(java.lang.String paramName) Get a named output parameter
FeedMetaData[]	getOutputParameters() Get the meta data for this Content Store.
void	setClassName(java.lang.String className) Set the name of the class implementing this datafeeder

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Method Detail

getName

public java.lang.String getName()

Get the name of the underlying feed

Specified by:

getName in interface ModelObject

Following copied from interface: oracle.panama.model.ModelObject

Returns:

String the name of the object

getData

public java.util.Map[] getData(java.util.Map params)
                        throws PanamaException

Retrieve the data feed from application's feed table for a given set of parameters. The method will return all matching rows. Each row is presented in the returned vector as a Map (hashtable). The values contained in the returned hashtable are in the format of Attr/value. If no data is found or if there is no cache table the method will return null.

getInputParameters

public FeedMetaData[] getInputParameters()

Get the meta data for this Content Store.

Returns:

an array of all input paramters

getOutputParameters

public FeedMetaData[] getOutputParameters()

Get the meta data for this Content Store.

Returns:

an array of all output paramters

addInputParameters

public void addInputParameters(FeedMetaData[] param)

Set the meta data for this Content Store.

Parameters:

an - array of all input paramters

addOutputParameters

public void addOutputParameters(FeedMetaData[] param)

set the meta data for this Content Store.

Parameters:

an - array of all output paramters

setClassName

public void setClassName(java.lang.String className)

Set the name of the class implementing this datafeeder

getClassName

public java.lang.String getClassName()

Get the name of the class implementing this datafeeder For the 'standard' DataFeeder this will be null

Returns:

name of class that implements the data feeder

createMetaData

public FeedMetaData createMetaData(java.lang.String name,
                                   java.lang.String type)

Create a FeedMetaData instance, for use with add{Input,Output}Parameter

Parameters:

name - of the new FeedMetaData

Returns:

new FeedMetaData instance

getInputParameter

public FeedMetaData getInputParameter(java.lang.String paramName)

Get a named input parameter.

Parameters:

name - of input parameter to get

Returns:

FeedMetaData definition for the parameter, null if not found

getOutputParameter

public FeedMetaData getOutputParameter(java.lang.String paramName)

Get a named output parameter

Parameters:

name - of output parameter to get

Returns:

FeedMetaData definition for the parameter, null if not found

createFeedDefinition

public void createFeedDefinition()
                          throws PanamaException

Create the feed definition -- this will register the Input/Output parameters with the alert framework and create the cache table if needed. It is assumed that the client has defined the columns in the table by calling setInputParameters() and setOutputParameters() first.

Throws:

PanamaException - if the table cannot be created