org.eclipse.stp.core.saf.handler
Interface IHandler

All Known Subinterfaces:
IComponentHandler, IEntryPointHandler, IExternalServiceHandler, IInterfaceHandler
All Known Implementing Classes:
AbstractComponentHandler, AbstractEntryPointHandler, AbstractExternalServiceHandler, AbstractHandler, AbstractInterfaceHandler

public interface IHandler

This class provides a common interface for all handlers contributed to the framework.


Method Summary
 java.lang.String getDescription()
          Returns text that describes the component, external service, entry point, or interface kind.
 java.lang.String getDescriptiveKindName()
          Returns a string describing the handler kind.
 java.lang.String getKind()
          Returns a string corresponding to a component, external service, entry point, or interface kind.
 java.net.URL getLargeIcon()
          Returns the URL for the large icon resource thet represents the corresponding component, entry point, external service, or interface kind.
 java.lang.String getName()
          Returns a name for the component, external service, entry point, or interface kind.
 java.net.URL getSmallIcon()
          Returns the URL for the small icon resource thet represents the corresponding component, entry point, external service, or interface kind.
 

Method Detail

getKind

public java.lang.String getKind()
Returns a string corresponding to a component, external service, entry point, or interface kind. This string acts as an identifier for a component, external service, entry point, or interface handler (the handler registered to process the specified kind).

Returns:
the QName string of the implementation kind of a component, or the binding kind of an external service or entry point, or an interface kind of an SCA interface

getDescriptiveKindName

public java.lang.String getDescriptiveKindName()
Returns a string describing the handler kind. This string is translated and is suitable for user dialogs and messages. For instance, if a given object can be processed by several different types of handlers, such as component and interface handlers, the user must be presented with a set of available choices. These choices can be worded using the descriptive kind name.

Returns:
the descriptive kind name for this handler

getName

public java.lang.String getName()
Returns a name for the component, external service, entry point, or interface kind. This string is intended to be suitable for display to an end user.

Returns:
the name of the implementation kind of a component, or the binding kind of an external service or entry point, or the interface kind of an SCA interface.

getDescription

public java.lang.String getDescription()
Returns text that describes the component, external service, entry point, or interface kind. This string is intended to be suitable for display to an end user.

Returns:
the description for the implementation kind of a component, or the binding kind of an external service or entry point, or the interface kind of an SCA interface

getSmallIcon

public java.net.URL getSmallIcon()
Returns the URL for the small icon resource thet represents the corresponding component, entry point, external service, or interface kind. The image is intended to be suitable for display to an end user.

Returns:
URL for icon resource

getLargeIcon

public java.net.URL getLargeIcon()
Returns the URL for the large icon resource thet represents the corresponding component, entry point, external service, or interface kind. The image is intended to be suitable for display to an end user.

Returns:
URL for icon resource