|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.sree.schedule.DefaultUserAction
public abstract class DefaultUserAction
This is the base class for all user defined schedule actions. All user defined actions must extend this class or implements the UserAction interface. A user action should always implements the equals method, otherwise a task with user action will always be treated as modified when it is reloaded by the Scheduler.
| Field Summary | |
|---|---|
protected RepletRequest |
request
|
| Constructor Summary | |
|---|---|
DefaultUserAction()
|
|
| Method Summary | |
|---|---|
boolean |
equals(Object val)
Check if the two user action is same action. |
abstract String |
getLabel()
Get the action label. |
RepletRequest |
getRepletRequest()
Get the action request object. |
void |
parseAttributes(Element element)
Parses the custom XML attributes for this action. |
void |
parseContent(Element element)
Parses the custom XML body content for this action. |
void |
parseXML(Element tag)
|
abstract void |
run(Principal principal)
Execute the action. |
void |
setRepletRequest(RepletRequest request)
Set the request to use for this action. |
String |
toString()
To String. |
void |
writeAttributes(PrintWriter writer)
Writes the custom XML attributes for this action. |
void |
writeContent(PrintWriter writer)
Writes the custom XML body content for this action. |
void |
writeXML(PrintWriter writer)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected RepletRequest request
| Constructor Detail |
|---|
public DefaultUserAction()
| Method Detail |
|---|
public abstract void run(Principal principal)
throws Throwable
run in interface ScheduleActionprincipal - represents an entity
Throwablepublic void setRepletRequest(RepletRequest request)
setRepletRequest in interface UserActionrequest - action request.public RepletRequest getRepletRequest()
getRepletRequest in interface UserActionpublic void writeAttributes(PrintWriter writer)
writer - the stream to which the XML is written.
public void parseAttributes(Element element)
throws Exception
element - the XML representation of this action.
Exception - if an error occurs while parsing.public void writeContent(PrintWriter writer)
writer - the stream to which the XML is written.
public void parseContent(Element element)
throws Exception
element - the XML representation of this action.
Exception - if an error occurs during parsing.public final void writeXML(PrintWriter writer)
writeXML in interface inetsoft.util.XMLSerializable
public final void parseXML(Element tag)
throws Exception
parseXML in interface inetsoft.util.XMLSerializableExceptionpublic boolean equals(Object val)
equals in class Objectpublic abstract String getLabel()
getLabel in interface UserActionpublic String toString()
toString in class Object
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||