com.mindoo.remote.api.org.eclipse.ui.services
Interface IRemoteServiceLocator

All Known Subinterfaces:

IRemoteViewSite, IRemoteWorkbench, IRemoteWorkbenchPartSite, IRemoteWorkbenchSite, IRemoteWorkbenchWindow

public interface IRemoteServiceLocator

A component with which one or more services are registered. The services can be retrieved from this locator using some key -- typically the class representing the interface the service must implement.

For example:
IRemoteMyService service = (IRemoteMyService) workbenchWindow.getService(IRemoteMyService.class);

Method Summary

java.lang.Object	getService(java.lang.Class api) Retrieves the service corresponding to the given API.
boolean	hasService(java.lang.Class api) Whether this service exists within the scope of this service locator.

Method Detail

getService

java.lang.Object getService(java.lang.Class api)
                            throws RemoteEclipseAPIException

Retrieves the service corresponding to the given API.

Parameters:

api - This is the interface that the service implements. Must not be null.

Returns:

The service, or null if no such service could be found.

Throws:

RemoteEclipseAPIException

hasService

boolean hasService(java.lang.Class api)
                   throws RemoteEclipseAPIException

Whether this service exists within the scope of this service locator. This does not include looking for the service within the scope of the parents. This method can be used to determine whether a particular service supports nesting in this scope.

Parameters:

api - This is the interface that the service implements. Must not be null.

Returns:

true iff the service locator can find a service for the given API; false otherwise.

Throws:

RemoteEclipseAPIException