com.mindoo.remote.api.com.ibm.rcp.propertybroker.service
Interface IRemotePropertyBroker

All Superinterfaces:

IRemoteEclipseWrapper

public interface IRemotePropertyBroker
extends IRemoteEclipseWrapper

Remote API Wrapper for the com.ibm.rcp.propertybroker.service.PropertyBroker (Online documentation)

Original documentation:
This is the main Property Broker interface for the implemented broker.

Definitions/Terminology

Property - an element owned by an Action. Parameter - an input or output element for an action definition. A property is contained within the parameter Action - an executable operation that can be called with a single input parameter. Owner - the owner can be different depending on the type of object you are referring to. An actions owner is usually a view ID (the primary id) or it can be the plugin id the action was contributed by (usually in basic cases where a plugin contains one view).

Method Summary

void	callAction(IRemoteAction action, java.lang.String propertyValue, java.lang.String targetEntityId, java.lang.String sourceEntityId) This method is equivalent to a runtime wire where the passed in action is called with a property change for the passed in Property.
IRemoteAction	getAction(java.lang.Object owner, java.lang.String actionName) Return the action registered for the given owner.
IRemoteAction[]	getActions(java.lang.Object owner) Return all the actions registered for the given owner.

Methods inherited from interface com.mindoo.remote.api.IRemoteEclipseWrapper

_internalGetId, equalWrappedObjects

Method Detail

callAction

void callAction(IRemoteAction action,
                java.lang.String propertyValue,
                java.lang.String targetEntityId,
                java.lang.String sourceEntityId)
                throws RemoteEclipseAPIException

This method is equivalent to a runtime wire where the passed in action is called with a property change for the passed in Property.

Parameters:

action - the action to call

propertyValue - The property value to pass on to the actions

targetEntityId - The target Entity ID to use

sourceEntityId - The source Entity ID to use

Throws:

RemoteEclipseAPIException

getAction

IRemoteAction getAction(java.lang.Object owner,
                        java.lang.String actionName)
                        throws RemoteEclipseAPIException

Return the action registered for the given owner.

Parameters:

owner -

actionName -

Returns:

an array containing all the actions for the owner

Throws:

RemoteEclipseAPIException

getActions

IRemoteAction[] getActions(java.lang.Object owner)
                           throws RemoteEclipseAPIException

Return all the actions registered for the given owner.

Parameters:

owner -

Returns:

an array containing all the actions for the owner

Throws:

RemoteEclipseAPIException