| org.apache.cocoon.components.modules.output.OutputModule
All known Subclasses: org.apache.cocoon.components.modules.output.AbstractOutputModule,
OutputModule | public interface OutputModule extends Component(Code) | | Communicate results to other components. This could be done via
request attributes, session attribute etc. Implementors should obey
the transactional nature and e.g. queue values as request
attributes and do the real communication e.g. to a bean only when
the transaction completes successfully.
author: Christian Haul version: CVS $Id: OutputModule.java 433543 2006-08-22 06:22:54Z crossley $ |
Method Summary | |
void | commit(Configuration modeConf, Map objectModel) Signal that the database transaction completed
successfully. | void | rollback(Configuration modeConf, Map objectModel, Exception e) If a database transaction needs to rollback, this is called to
inform the further processing logic about this fact. | void | setAttribute(Configuration modeConf, Map objectModel, String name, Object value) communicate an attribute value to further processing logic. |
rollback | void rollback(Configuration modeConf, Map objectModel, Exception e)(Code) | | If a database transaction needs to rollback, this is called to
inform the further processing logic about this fact. All
already set attribute values are invalidated. This is difficult
because only the request object can be used to synchronize this
and build some kind of transaction object. Beaware that sending
your data straight to some beans or other entities could result
in data corruption!
|
setAttribute | void setAttribute(Configuration modeConf, Map objectModel, String name, Object value)(Code) | | communicate an attribute value to further processing logic. OutputModules
work in implicit transaction mode, thus setting an attribute starts an
transaction and sttributes are only visible after the transaction is
successfully completed with a call to commit
Parameters: modeConf - column's mode configuration from resourcedescription. This argument is optional. Parameters: objectModel - The objectModel Parameters: name - The attribute's label, consisting of "table.column"or "table.column[index]" in case of multiple attributes of thesame spec. Parameters: value - The attriute's value. |
|
|