Action

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> javahispano >> canyamo >> core >> [ action overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.javahispano.canyamo.core.action.Action

SOURCE |

Download org.javahispano.canyamo.core.action.Action

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.javahispano.canyamo.core.action
Interface Action

All Known Implementing Classes:: AbstractAction

public interface Action

Interface that should implement all actions to be managed by Canyamo.

An action is a "process" that Canyamo can execute in response to an User request.
Actions should manipulated the data in order to satisfied User's request, and put data related to the response in WorkData, which will be passed to the associated Displayer, which would render the response in HTML form.

Version:

Method Summary

void addActionListener(ActionListener listener)
          Adds a Displayer as Listener for this Action

This should be used in the case that some displayers do some kind of content caching.

void addProperty(java.lang.String name, java.lang.String value)
          Adds a configuration property to the action

void fireActionEvent()
          Notifies all listeners that the Action has been executed

org.javahispano.canyamo.core.application.Application getApplication()
          Gets the Application to which this action belong to

java.lang.String getDescription()
          Returns a descriptive text of the action

java.lang.String getDisplayer()
          Gets the Displayer associated to this action

java.lang.String getName()
          Action name as string

int getStatistic()
          Gets an statistic value of this Action.

void init()
          Initilizes Action if necessary

void process(org.javahispano.canyamo.core.WorkData data)
          Process of User's request.

void setApplication(org.javahispano.canyamo.core.application.Application app)
          Sets the Application to which this action belong to

void setDisplayer(java.lang.String displayer)
          Sets the Displayer associated with this Action

void setName(java.lang.String name)
          Sets Action's name

Method Detail

process

public void process(org.javahispano.canyamo.core.WorkData data)
             throws org.javahispano.canyamo.core.CanyamoException

Process of User's request.

init

public void init()

Initilizes Action if necessary

getName

public java.lang.String getName()

Action name as string

setName

public void setName(java.lang.String name)

Sets Action's name

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)

Adds a configuration property to the action

setDisplayer

public void setDisplayer(java.lang.String displayer)

Sets the Displayer associated with this Action

getDisplayer

public java.lang.String getDisplayer()

Gets the Displayer associated to this action

getDescription

public java.lang.String getDescription()

Returns a descriptive text of the action

addActionListener

public void addActionListener(ActionListener listener)

Adds a Displayer as Listener for this Action

This should be used in the case that some displayers do some kind of content caching.

fireActionEvent

public void fireActionEvent()

Notifies all listeners that the Action has been executed

setApplication

public void setApplication(org.javahispano.canyamo.core.application.Application app)

Sets the Application to which this action belong to

getApplication

public org.javahispano.canyamo.core.application.Application getApplication()

Gets the Application to which this action belong to

getStatistic

public int getStatistic()

Gets an statistic value of this Action.
Normally it's a count of values or a count values in "to do" for admin actions