com.ibm.carma.ui.action.custom
Class CustomActionUtil
java.lang.Object
com.ibm.carma.ui.action.custom.CustomActionUtil
public class CustomActionUtil
- extends java.lang.Object
This is a Utility class that has methods to help implementors fetch the custom parameters.
This class correctly queries the CustomActionParameterManager, the user and the preferences as
necessary to return the correct Object array for the given resource and ActionIdentifier.
|
Field Summary |
static java.lang.String |
COPYRIGHT
|
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- See Also:
- Constant Field Values
CustomActionUtil
public CustomActionUtil()
getCustomParameters
public static java.lang.Object[] getCustomParameters(CustomActionAccepter resource,
java.lang.String actionId)
throws org.eclipse.core.runtime.CoreException,
NotSynchronizedException,
org.eclipse.core.runtime.OperationCanceledException
- This method will do all that is necessary to get the correct custom action parameters.
It is acceptable to use these results and pass them directly to the action.
- Parameters:
resource - a CARMAResource against which the action is going to be performed.actionId - The Id that relates to the action, from ActionIdentifier
- Returns:
- the custom parameters input by the user
- Throws:
org.eclipse.core.runtime.CoreException - if
- the operation is cancelled by the user.
NotSynchronizedException - if the RepositoryManager needs to be connected to build up the
Action List
org.eclipse.core.runtime.OperationCanceledException - the operation was cancelled by the user
getCustomParametersForTask
public static java.lang.Object[] getCustomParametersForTask(CarmaTaskMemento memento,
CustomActionAccepter resource,
java.lang.String actionId)
throws org.eclipse.core.runtime.CoreException,
NotSynchronizedException,
org.eclipse.core.runtime.OperationCanceledException
- This method should be used to get the custom parameters inside a task. This ensures that
the dialog isn't displayed if the user asks it not to be unless necessary.
- Parameters:
memento - an instance of TaskMemento which keeps track of the information for the callerresource - a CARMAResource against which the action is going to be performed.actionId - The Id that relates to the action, from com.ibm.carma.model.ActionIdentifier
- Returns:
- custom parameters input by the user
- Throws:
org.eclipse.core.runtime.CoreException - if
- the operation is cancelled by the user.
NotSynchronizedException - if the RepositoryManager needs to be connected to build up the
Action List
org.eclipse.core.runtime.OperationCanceledException - the operation was cancelled by the user