com.mindoo.remote.api.com.ibm.rcp.propertybroker.property
Interface IRemoteAction

All Superinterfaces:
IRemoteEclipseWrapper

public interface IRemoteAction
extends IRemoteEclipseWrapper

Remote API Wrapper for the com.ibm.rcp.propertybroker.property.Action (Online documentation)

Original documentation:
The Action definition interface. This interface defines how an Action is defined and registered with the broker. The definition information primarily comes from the WSDL which is part of the Action extension point.


Method Summary
 java.lang.String getDescription()
          This method will return the Description from the WSDL.
 java.lang.String getName()
          Returns the name of the action.
 java.lang.Object getOwnerId()
          Returns an id representing the plugin which registered this action.
 java.lang.String getTitle()
          This method will return the Title from the WSDL.
 
Methods inherited from interface com.mindoo.remote.api.IRemoteEclipseWrapper
_internalGetId, equalWrappedObjects
 

Method Detail

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException
Returns the name of the action. Must be unique for a given portlet. This name can also be translated through an ID specified in the WSDL. The method will attempt to get the translated value from the orginating bundle.

Returns:
a String containing the action name
Throws:
RemoteEclipseAPIException

getTitle

java.lang.String getTitle()
                          throws RemoteEclipseAPIException
This method will return the Title from the WSDL. The method attempts to get the translated version of the Title by accessing the default Resource Bundle.

Returns:
a String containing the title
Throws:
RemoteEclipseAPIException

getOwnerId

java.lang.Object getOwnerId()
                            throws RemoteEclipseAPIException
Returns an id representing the plugin which registered this action.

Returns:
an Object representing the id of the plugin which registered this action. May be used in comparisons.
Throws:
RemoteEclipseAPIException

getDescription

java.lang.String getDescription()
                                throws RemoteEclipseAPIException
This method will return the Description from the WSDL. The method attempts to get the translated version of the Description by accessing the default Resource Bundle.

Returns:
a String containing the description
Throws:
RemoteEclipseAPIException