|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.core.internal.jobs.InternalJob
org.eclipse.core.runtime.jobs.Job
com.ibm.carma.ui.job.AbstractCarmaJob
public abstract class AbstractCarmaJob
AbstractCarmaJob should be used by extenders to create Jobs operating on connected or disconnected CARMA objects.
There are many helper functions to handle common cases such as NotSynchronized or NotConnected exceptions. If the action being performed is not complex, users should instead consider extending CustomActionJob instead, as it requires less work to extend
| Field Summary | |
|---|---|
static java.lang.String |
COPYRIGHT
|
| Fields inherited from class org.eclipse.core.runtime.jobs.Job |
|---|
ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING |
| Constructor Summary | |
|---|---|
AbstractCarmaJob(java.lang.String name)
Create a new Job with the specified name. |
|
| Method Summary | |
|---|---|
void |
displayCustomReturns(CARMAContent resource,
CARMAReturn returnValues)
Opens a dialog to display the given custom returns to the user. |
void |
displayCustomReturns(CARMAContent resource,
java.util.Map<? extends CARMAContent,? extends CARMAReturn> map)
Opens a dialog to display the given custom returns to the user. |
void |
displayCustomReturns(CustomActionAccepter resource,
java.lang.String actionId,
java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> map)
Opens a dialog to display the given custom returns to the user. |
void |
displayCustomReturns(java.lang.String actionId,
java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> map)
Opens a dialog to display the given custom returns to the user. |
static Action |
getActionFromReturns(CARMAReturn returnValues)
Walks the return value structure and determines the action the returns come from |
static java.lang.String |
getActionName(CARMAResource resource,
java.lang.String actionId)
Determines the (displayable) action name based on the given resource and action Id |
| Methods inherited from class org.eclipse.core.runtime.jobs.Job |
|---|
addJobChangeListener, belongsTo, cancel, done, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, removeJobChangeListener, schedule, schedule, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, wakeUp, wakeUp |
| Methods inherited from class org.eclipse.core.internal.jobs.InternalJob |
|---|
compareTo, toString |
| Methods inherited from class org.eclipse.core.runtime.PlatformObject |
|---|
getAdapter |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
|---|
getAdapter |
| Field Detail |
|---|
public static final java.lang.String COPYRIGHT
| Constructor Detail |
|---|
public AbstractCarmaJob(java.lang.String name)
name - the name of the job| Method Detail |
|---|
public static Action getActionFromReturns(CARMAReturn returnValues)
returnValues - the return value to gather the action specification from
public void displayCustomReturns(CARMAContent resource,
CARMAReturn returnValues)
resource - the resource to display the custom returns forreturnValues - the custom return values to display
public void displayCustomReturns(CARMAContent resource,
java.util.Map<? extends CARMAContent,? extends CARMAReturn> map)
resource - the resource to display the custom returns formap - map of the custom return values to display
public void displayCustomReturns(java.lang.String actionId,
java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> map)
actionId - the identifier of the action executedmap - the map of return values from the executed action
public void displayCustomReturns(CustomActionAccepter resource,
java.lang.String actionId,
java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> map)
resource - the resource to display the custom returns foractionId - the identifier of the action executedmap - the map of return values from the executed action
public static java.lang.String getActionName(CARMAResource resource,
java.lang.String actionId)
Id
resource - resource the action is associated withactionId - identifier of the action in the CARMA system
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||