com.orderlysoftware.orderlycalls.base
Class Definition

java.lang.Object
  extended by com.orderlysoftware.orderlycalls.base.Definition

public class Definition
extends java.lang.Object

Class relates the configuration file XML tags to the Service and Settingsobjects they represent.

Author:
Matt King, M.A. Oxon.

Constructor Summary
Definition(java.lang.String tag, java.lang.String className, java.lang.String settingsName)
          Creates a new Service Definition.
 
Method Summary
 java.lang.String getClassName()
          Gets the full name of the Service class.
 java.lang.String getSettingsName()
          Gets the full name of the Settings class that will hold initialisation paramaters for this Service.
 java.lang.String getTag()
          Gets the name of the tag that will represent this kind of Service.
 void setClassName(java.lang.String className)
          Sets the full name of the Service class.
 void setSettingsName(java.lang.String settingsName)
          Sets the full name of the Settings class.
 void setTag(java.lang.String tag)
          Sets the name of the tag that will represent this kind of Service.
 java.lang.String toString()
          Convenience method for logging.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Definition

public Definition(java.lang.String tag,
                  java.lang.String className,
                  java.lang.String settingsName)
Creates a new Service Definition.

Parameters:
tag - The name of the tag that will appear in the Services section of the XML configuration document.
className - The name of the class (including package) that will instantiate the service.
settingsName - The name of the settings class (including package) that will be used to pass data to the service.
Method Detail

getClassName

public java.lang.String getClassName()
Gets the full name of the Service class.

Returns:
Returns the className.

setClassName

public void setClassName(java.lang.String className)
Sets the full name of the Service class.

Parameters:
className - The className to set.

getSettingsName

public java.lang.String getSettingsName()
Gets the full name of the Settings class that will hold initialisation paramaters for this Service.

Returns:
Returns the settingsName.

setSettingsName

public void setSettingsName(java.lang.String settingsName)
Sets the full name of the Settings class.

Parameters:
settingsName - The settingsName to set.

getTag

public java.lang.String getTag()
Gets the name of the tag that will represent this kind of Service.

Returns:
Returns the tag.

setTag

public void setTag(java.lang.String tag)
Sets the name of the tag that will represent this kind of Service.

Parameters:
tag - The tag to set.

toString

public java.lang.String toString()
Convenience method for logging.

Overrides:
toString in class java.lang.Object