org.eclipse.rse.ui.view
Interface ISystemSelectRemoteObjectAPIProvider

All Superinterfaces:

IAdaptable, ISystemViewInputProvider

public interface ISystemSelectRemoteObjectAPIProvider

extends ISystemViewInputProvider

Since:

3.0

Method Summary

Object[]	getConnectionChildren(IHost selectedConnection) This method is called by the connection adapter when the user expands a connection.
String	getPreSelectFilterChild() Get the name of the item to select when the first filter is expanded.
Object	getPreSelectFilterChildObject() Get the actual object of the item to select when the first filter is expanded.
void	setFilterString(String string) Set the filter string to use to resolve the inputs.
void	setPreSelectFilterChild(String name) Set child of the first filter to preselect
void	setPreSelectFilterChildObject(Object obj) Set actual child object of the first filter to preselect.
void	setQuickFilters(ISystemFilter[] filters) Set the quick filters to be exposed to the user.
void	setShowNewConnectionPrompt(boolean show) Specify whether the user should see the "New Connection..." special connection prompt
void	setSystemConnection(IHost connection, boolean onlyMode) Default or Restrict to a specific connection.
void	setSystemTypes(IRSESystemType[] systemTypes) Specify system types to restrict what types of connections the user can create, and see.

Methods inherited from interface org.eclipse.rse.core.model.ISystemViewInputProvider

getAdapter, getSystemViewRoots, getViewer, hasConnectionChildren, hasSystemViewRoots, setViewer, showingConnections

Method Detail

getConnectionChildren

public Object[] getConnectionChildren(IHost selectedConnection)

This method is called by the connection adapter when the user expands a connection. This method must return the child objects to show for that connection.

Specified by:

getConnectionChildren in interface ISystemViewInputProvider

Parameters:

selectedConnection - the connection undergoing expansion

Returns:

the list of objects under the connection

getPreSelectFilterChild

public String getPreSelectFilterChild()

Get the name of the item to select when the first filter is expanded. Called by the filter adapter.

getPreSelectFilterChildObject

public Object getPreSelectFilterChildObject()

Get the actual object of the item to select when the first filter is expanded. Called by the GUI form after expansion, so it can select this object

setFilterString

public void setFilterString(String string)

Set the filter string to use to resolve the inputs. If this is an absolute filter string, it gets turned into a quick filter string, so that the user sees it and can expand it. If it is a relative filter string to apply to all expansions, it is used to decorate all filtering as the user drills down.

setPreSelectFilterChildObject

public void setPreSelectFilterChildObject(Object obj)

Set actual child object of the first filter to preselect. Called by the filter adapter once the children are resolved and a match on the name is found.

setPreSelectFilterChild

public void setPreSelectFilterChild(String name)

Set child of the first filter to preselect

setQuickFilters

public void setQuickFilters(ISystemFilter[] filters)

Set the quick filters to be exposed to the user. These will be shown to the user when they expand a connection.

See Also:

org.eclipse.rse.core.filters.SystemFilterSimple

setShowNewConnectionPrompt

public void setShowNewConnectionPrompt(boolean show)

Specify whether the user should see the "New Connection..." special connection prompt

setSystemConnection

public void setSystemConnection(IHost connection,
                                boolean onlyMode)

Default or Restrict to a specific connection. If default mode, it is preselected. If only mode, it is the only connection listed.

Parameters:

connection - The connection to default or restrict to

onlyMode - true if this is to be the only connection shown in the list

setSystemTypes

public void setSystemTypes(IRSESystemType[] systemTypes)

Specify system types to restrict what types of connections the user can create, and see. This will override subsystemConfigurationId,if that has been set!

Parameters:

systemTypes - An array of system types, or null to allow all registered valid system types. A system type is valid if at least one subsystem configuration is registered against it.