Openwings API Documentation (v1.1)

net.openwings.component.utilities
Class UserInterfaceDescriptor

java.lang.Object
  extended bynet.openwings.component.utilities.UserInterfaceDescriptor
All Implemented Interfaces:
java.io.Serializable

public class UserInterfaceDescriptor
extends java.lang.Object
implements java.io.Serializable

This class is used to provide metadata about a user interface that is associated with a particular service.

See Also:
Serialized Form

Constructor Summary
UserInterfaceDescriptor()
          Default constructor (empty).
UserInterfaceDescriptor(java.lang.Class supportedServiceInterface, java.lang.Class supportedUIClasses)
          This is the primary public constructor for the UserInterfaceDescriptor class.
 
Method Summary
 java.lang.String getName()
          This method returns the name of the user interface.
 java.lang.Class getSupportedServiceInterface()
          This method returns the service interface supported by the user interface
 java.lang.Class getSupportedUIClass()
          This method returns the the Java type of the user interface.
 void setSupportedServiceInterface(java.lang.Class supportedServiceInterface)
          This method sets the service interface supported by the user interface
 void setSupportedUIClass(java.lang.Class supportedUIClass)
          This method sets the the Java type of the user interface.
 java.lang.String toString()
          overrides default toString() method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UserInterfaceDescriptor

public UserInterfaceDescriptor()
Default constructor (empty).


UserInterfaceDescriptor

public UserInterfaceDescriptor(java.lang.Class supportedServiceInterface,
                               java.lang.Class supportedUIClasses)
This is the primary public constructor for the UserInterfaceDescriptor class.

Parameters:
supportedServiceInterface - service interface supported by the user interface
Method Detail

getName

public java.lang.String getName()
This method returns the name of the user interface.

Returns:
class name of the user interface implementation

getSupportedUIClass

public java.lang.Class getSupportedUIClass()
This method returns the the Java type of the user interface.

Returns:
the Java type of the interface

setSupportedUIClass

public void setSupportedUIClass(java.lang.Class supportedUIClass)
This method sets the the Java type of the user interface.

Parameters:
supportedUIClass - the Java type of the interface

getSupportedServiceInterface

public java.lang.Class getSupportedServiceInterface()
This method returns the service interface supported by the user interface

Returns:
service interface supported by the user interface

setSupportedServiceInterface

public void setSupportedServiceInterface(java.lang.Class supportedServiceInterface)
This method sets the service interface supported by the user interface

Parameters:
supportedServiceInterface - service interface supported by the user interface

toString

public java.lang.String toString()
overrides default toString() method.


Openwings API Documentation (v1.1)