|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface CustomActionAccepter
A representation of the model object 'Custom Action Accepter'. Allows custom action configuration on object methods
ModelPackage.getCustomActionAccepter()| Field Summary | |
|---|---|
static java.lang.String |
copyright
|
| Method Summary | |
|---|---|
Action |
findActionFor(java.lang.String actionId)
Returns the action associated with the given action Id. |
void |
markActionUnsupported(java.lang.String actionId)
Marks the given action as unsupported in the RAM action configuration. |
CARMAReturn |
performAction(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String actionId,
java.lang.Object[] parameters)
Issues a custom command on the content that is to be sent to the CARMA host. |
| Methods inherited from interface org.eclipse.emf.ecore.EObject |
|---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
| Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
|---|
eAdapters, eDeliver, eNotify, eSetDeliver |
| Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
|---|
getAdapter |
| Field Detail |
|---|
static final java.lang.String copyright
| Method Detail |
|---|
Action findActionFor(java.lang.String actionId)
throws NotSynchronizedException
actionId - the action identifier to locate in the Action configuration for the object
NotSynchronizedException - The action configuration has not been initializedvoid markActionUnsupported(java.lang.String actionId)
actionId - the action identifier to mark unsupported in the Action configuration for the object
CARMAReturn performAction(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String actionId,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
NotConnectedException,
UnsupportedCARMAOperationException
Performs a custom action specific to the RepositoryManager. The actionId
is found in the list of valid actions and
executed after the parameters are verified.
The action specification can be located using the findActionFor(String)
method and inspecting the action object returned. The parameter array is expected to consist of object
values of the type defined by the action parameter list in the order
specified by the parameter list.
The parameters array should:
parameters specificationtype specified for each parameter
pm - the progress monitor for the operationactionId - the identifier of the action to perform on the CARMA hostparameters - the set of parameters required for the method to execute properly
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the host
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||