com.mindoo.remote.api.ca
Interface IRemoteComponentTools

public interface IRemoteComponentTools

Several useful methods to create Composite Application components and modify their component data

Method Summary

void	createWire(IRemoteViewPart sourcePart, IRemoteViewPart targetPart, java.lang.String sourceWireName, java.lang.String targetWireName, java.lang.String wireId, java.lang.String wireTitle) Method to create a CA wire between two IRemoteViewParts in code
IRemoteTopologyHandler	getTopologyHandler() Returns a topology handler wrapper.
void	showComponentInPage(IRemoteWorkbenchPage page, java.lang.String primaryId, java.lang.String secondaryId, java.util.Map<java.lang.Object,java.lang.Object> parameters) Helper method to create a new Component in the specified IRemoteWorkbenchPage.
void	showCompositeApplication(java.net.URL url, java.lang.String pageId, boolean blocking) The method wraps com.ibm.rcp.portal.app.ui.service.CompositeApplicationUIService#showApplication(java.net.URL,java.lang.String,org.eclipse.core.runtime.IProgressMonitor progressMonitor) and adds an option to wait for the CA to get opened

Method Detail

showComponentInPage

void showComponentInPage(IRemoteWorkbenchPage page,
                         java.lang.String primaryId,
                         java.lang.String secondaryId,
                         java.util.Map<java.lang.Object,java.lang.Object> parameters)
                         throws RemoteEclipseAPIException

Helper method to create a new Component in the specified IRemoteWorkbenchPage.
The same functionality can be achieved by manually registering the component data via IRemoteTopologyHandler.modifyComponent(Map, String) and displaying the Component's view with IRemoteWorkbenchPage.showView(String, String, int)

Parameters:

page - page in which the component should be created

primaryId - primary id of the component

secondaryId - secondary id of the component

parameters - map with Component Data

Throws:

RemoteEclipseAPIException

showCompositeApplication

void showCompositeApplication(java.net.URL url,
                              java.lang.String pageId,
                              boolean blocking)
                              throws RemoteEclipseAPIException

The method wraps com.ibm.rcp.portal.app.ui.service.CompositeApplicationUIService#showApplication(java.net.URL,java.lang.String,org.eclipse.core.runtime.IProgressMonitor progressMonitor) and adds an option to wait for the CA to get opened

Parameters:

url - The URL to retrieve the application description.

pageId - Optional identifier of page (perspective) to show.

blocking - true to wait for the CA to get opened

Throws:

RemoteEclipseAPIException

createWire

void createWire(IRemoteViewPart sourcePart,
                IRemoteViewPart targetPart,
                java.lang.String sourceWireName,
                java.lang.String targetWireName,
                java.lang.String wireId,
                java.lang.String wireTitle)
                throws RemoteEclipseAPIException

Method to create a CA wire between two IRemoteViewParts in code

Parameters:

sourcePart - source part

targetPart - target part

sourceWireName - source wire name

targetWireName - target wire name

wireId - wire id

wireTitle - title of the wire

Throws:

RemoteEclipseAPIException

getTopologyHandler

IRemoteTopologyHandler getTopologyHandler()
                                          throws RemoteEclipseAPIException

Returns a topology handler wrapper. The topology handler is a service to read and modify Composite Application component data

Returns:

topology handler

Throws:

RemoteEclipseAPIException