|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface indicates an EventHandler takes a long time to run. As such, Barracuda will automatically send a response back to the browser giving the user the opportunity to a) see that its going to take a while and b) interrupt the process if they so choose.
Method Summary | |
List |
getAdditionalModels()
get any additional BTemplate models. |
int |
getElapsed()
get elapsed (in secs). |
int |
getETA()
get ETA (in secs). |
int |
getPercentComplete()
get the percent complete (int between 0 and 100). |
BaseEvent |
getRedirectEvent()
get the redirect event for this LongRunning process. |
int |
getRefreshRate()
get the refresh rate (in secs). |
StateMap |
getStateMap()
get the statemap (may be used for storing key/val info, which can then be retrieved from the template). |
Class |
getTemplateClass()
get the custom template class. |
void |
reset()
resets the start time. |
void |
setAdditionalModels(List imodels)
provide a List of additional BTemplate models to make available during to the LongRunningEventGateway template. |
void |
setElapsed(int secs)
set elapsed (in secs). |
void |
setETA(int secs)
set ETA (in secs). -1 indicates the DEFAULT_ETA will be used |
void |
setPercentComplete(int percent)
set the percent complete (int between 0 and 100). |
void |
setRedirectEvent(BaseEvent be)
Specify the redirect event to be fired if the LongRunning process is cancelled |
void |
setRefreshRate(int secs)
set the refresh rate (in secs). -1 indicates the DEFAULT_REFRESH_RATE will be used |
void |
setTemplateClass(Class cl)
provide a different Template class instead of the default Barracuda template, This will typically be used by developers who want to override L&F of the progress screen. |
Method Detail |
public void setRedirectEvent(BaseEvent be)
public BaseEvent getRedirectEvent()
public void setRefreshRate(int secs)
public int getRefreshRate()
public void setETA(int secs)
public int getETA()
public void setElapsed(int secs)
public int getElapsed()
public void setPercentComplete(int percent)
public int getPercentComplete()
public StateMap getStateMap()
public void setAdditionalModels(List imodels)
public List getAdditionalModels()
public void setTemplateClass(Class cl)
public Class getTemplateClass()
public void reset()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |