org.eclipse.rse.core.subsystems
Interface ISystemRemoteObjectMatchProvider
-
All Superinterfaces:
-
IRemoteObjectIdentifier
-
All Known Subinterfaces:
-
ISystemRemoteElementAdapter
-
All Known Implementing Classes:
-
SystemViewRemoteOutputAdapter
-
public interface ISystemRemoteObjectMatchProvider
- extends
IRemoteObjectIdentifier
This interface is designed to allow remote property pages to be registered
against specific remote system objects of specific name, type or subtype.
getName
String getName(
Object element)
- Return the name of this object, which may be different than
the display text (
getText(Object)
).
The unqualified name is used for checking uniqueness during rename
operations.
-
-
-
Parameters:
-
element
- the element for which to return the internal name.
-
Returns:
- a String representing the internal name of the given element.
getRemoteSourceType
String getRemoteSourceType(
Object element)
- Return the source type of the selected object.
Typically, this only makes sense for compilable source members.
For non-compilable remote objects, this typically just returns null.
-
-
-
Returns:
- the sourcetype id of this remote object,
or
null
if not applicable.
getRemoteSubSubType
String getRemoteSubSubType(
Object element)
- Return a value for the sub-subtype property for this object.
Not all object types support a sub-subtype, so returning null is ok.
The value must not be translated, so that property pages registered
via xml can subset by it.
-
-
-
Returns:
- the subsubtype id of this remote object for filtering.
May return
null
.
getRemoteSubType
String getRemoteSubType(
Object element)
- Return a value for the subtype property for this object.
Not all object types support a subtype, so returning null is ok.
The value must not be translated, so that property pages registered
via xml can subset by it.
-
-
-
Returns:
- the subtype id of this remote object for filtering.
May return
null
.
getRemoteType
String getRemoteType(
Object element)
- Return a value for the type property for this object.
The value must not be translated, so that property pages registered
via xml can subset by it.
-
-
-
Returns:
- the type id of this remote object for filtering.
getRemoteTypeCategory
String getRemoteTypeCategory(
Object element)
- Return a value for the type category property for this object.
The value must not be translated, so that property pages registered
via xml can subset by it.
-
-
-
Returns:
- the category id of this remote object for filtering.
getSubSystem
ISubSystem getSubSystem(
Object element)
- Return the subsystem that is responsible for getting this remote object.
When used together with getAbsoluteName, allows for unique
identification of this object.
-
-
-
Returns:
- the subsystem owning this remote object.
Must not return
null
.
getSubSystemConfigurationId
String getSubSystemConfigurationId(
Object element)
- Return the subsystem factory id that owns this remote object.
The value must not be translated, so that property pages registered
via xml can subset by it.
-
-
-
Returns:
- the ID of the subsystem configuration that created
the subsystem which owns this remote object.
getText
String getText(
Object element)
- Return the label for this object.
-
-
-
Parameters:
-
element
- the element for which to return the internal name.
-
Returns:
- a String representing the UI visible label of the given element.
-
See Also:
-
getName(Object)
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.