Eclipse RSE Development Guide (Galileo) - ISubSystemConfigurationProxy (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.subsystems
Interface ISubSystemConfigurationProxy

public interface ISubSystemConfigurationProxy

Interface to SubSystemConfigurationExtension class Internal use, not likely you will ever need to use it or access it directly.

Method Summary

boolean appliesToSystemType ( IRSESystemType type)
          Test if the given system type matches one or more of the systemTypes attribute of this extension.

String getCategory ()
          Return value of the category xml attribute.

String getDeclaredSystemTypeIds ()
          Return value of the systemTypeIds xml attribute.

Bundle getDeclaringBundle ()
          Returns the bundle which have declared the subsystem configuration associated with this proxy.

String getDescription ()
          Return value of the description xml attribute.

String getId ()
          Return value of the id xml attribute.

URL getImageLocation ()


URL getLiveImageLocation ()


String getName ()
          Return value of the name xml attribute.

int getPriority ()
          Returns the priority of the subsystem configuration.

ISubSystemConfiguration getSubSystemConfiguration ()
          Return the subsystem factory singleton instance.

IRSESystemType[] getSystemTypes ()
          Returns the list of system types the subsystem configuration is supporting.

String getVendor ()
          Return value of the vendor xml attribute.

boolean isSubSystemConfigurationActive ()
          Return true if the subsystem factory has been instantiated yet

void reset ()
          Reset for a full refresh from disk, such as after a team synch.

void restore ()
          After a reset, restore from disk

boolean supportsAllSystemTypes ()
          Return true if this factory supports all system types

Method Detail

getId


String getId()

Return value of the id xml attribute. Return unique id of this configuration.

getName


String getName()

Return value of the name xml attribute. Return name of this factory. Matches value in name attribute in extension point xml

getDescription


String getDescription()

Return value of the description xml attribute. Return description of this factory. Matches value in description attribute in extension point xml

getDeclaringBundle


Bundle getDeclaringBundle()

Returns the bundle which have declared the subsystem configuration associated with this proxy.

Returns:: The declaring bundle.

getDeclaredSystemTypeIds


String getDeclaredSystemTypeIds()

Return value of the systemTypeIds xml attribute. Return the system type ids this subsystem configuration supports.

getSystemTypes


IRSESystemType[] getSystemTypes()

Returns the list of system types the subsystem configuration is supporting. The list is combined from the list of currently registered system types cleaned up by the ones not matching the declared system type ids.

Returns:: The list of supported system types or an empty list.

supportsAllSystemTypes

boolean supportsAllSystemTypes()

Return true if this factory supports all system types

getVendor


String getVendor()

Return value of the vendor xml attribute. Return vendor of this configuration.

getCategory


String getCategory()

Return value of the category xml attribute. Return the category this subsystem configuration subscribes to.

See Also:: ISubSystemConfigurationCategories

isSubSystemConfigurationActive

boolean isSubSystemConfigurationActive()

Return true if the subsystem factory has been instantiated yet

getPriority

int getPriority()

Returns the priority of the subsystem configuration.

getSubSystemConfiguration


ISubSystemConfiguration getSubSystemConfiguration()

Return the subsystem factory singleton instance. Will instantiate if not already.

appliesToSystemType

boolean appliesToSystemType(
IRSESystemType type)

Test if the given system type matches one or more of the systemTypes attribute of this extension.

reset

void reset()

Reset for a full refresh from disk, such as after a team synch.

restore

void restore()

After a reset, restore from disk

getImageLocation


URL getImageLocation()

Returns:: the URL of the image associated with this subsystem in its non-connected state.

getLiveImageLocation


URL getLiveImageLocation()

Returns:: the URL of the image associated with this subsystem in its connected state.