com.ibm.commerce.adapter
Class DeviceFormatAdapterDesc

java.lang.Object
  |
  +--com.ibm.commerce.adapter.DeviceFormatAdapterDesc
Direct Known Subclasses:
HttpAdapterDesc

public class DeviceFormatAdapterDesc
extends java.lang.Object

Reserved for IBM internal use. DeviceFormatAdapterDesc is a base class that describes a device adapter.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copywrite notice field.
static java.lang.String DEVFMT_ENABLED
          The key used to determine whether the adapter should be enabled or not.
static java.lang.String DEVFMT_FACTORYCLASSNAME
          The key used to get the factory classname of the adapter from the adapter configuration.
static java.lang.String DEVFMT_ID
          The key used to get the device format identifier from the adapter configuration.
static java.lang.String DEVFMT_NAME
          The key used to get the device name from the adapter configuration.
static java.lang.String DEVFMT_TYPE
          The key used to get the name of the device format type from the adapter configuration.
static java.lang.String DEVFMT_TYPEID
          The key used to get the identifier of the device format type from the adapter configuration.
protected  java.lang.Class devfmtClass
           
protected  java.lang.Integer devfmtId
           
protected  java.lang.String devfmtName
           
protected  java.lang.String devfmtType
           
protected  java.lang.Integer devfmtTypeId
           
protected  boolean isEnabled
           
 
Constructor Summary
DeviceFormatAdapterDesc()
          Reserved for IBM internal use.
 
Method Summary
 java.lang.Class getDeviceFormatClass()
          Reserved for IBM internal use.
 java.lang.Integer getDeviceFormatId()
          Reserved for IBM internal use.
 java.lang.String getDeviceFormatName()
          Reserved for IBM internal use.
 java.lang.String getDeviceFormatType()
          Reserved for IBM internal use.
 java.lang.Integer getDeviceFormatTypeId()
          Reserved for IBM internal use.
 void init(org.w3c.dom.Element node)
          Reserved for IBM internal use.
 boolean isEnabled()
          Reserved for IBM internal use.
 void setDeviceFormatClass(java.lang.Class value)
          Reserved for IBM internal use.
 void setDeviceFormatId(java.lang.Integer value)
          Reserved for IBM internal use.
 void setDeviceFormatName(java.lang.String value)
          Reserved for IBM internal use.
 void setDeviceFormatType(java.lang.String value)
          Reserved for IBM internal use.
 void setDeviceFormatTypeId(java.lang.Integer value)
          Reserved for IBM internal use.
 void setIsEnabled(boolean value)
          Reserved for IBM internal use.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copywrite notice field.
See Also:
Constant Field Values

DEVFMT_NAME

public static final java.lang.String DEVFMT_NAME
The key used to get the device name from the adapter configuration. The current value is "name".
See Also:
Constant Field Values

DEVFMT_FACTORYCLASSNAME

public static final java.lang.String DEVFMT_FACTORYCLASSNAME
The key used to get the factory classname of the adapter from the adapter configuration. The current value is "factoryClassname".
See Also:
Constant Field Values

DEVFMT_ID

public static final java.lang.String DEVFMT_ID
The key used to get the device format identifier from the adapter configuration. The current value is "deviceFormatId".
See Also:
Constant Field Values

DEVFMT_TYPE

public static final java.lang.String DEVFMT_TYPE
The key used to get the name of the device format type from the adapter configuration. The current value is "deviceFormatType".
See Also:
Constant Field Values

DEVFMT_TYPEID

public static final java.lang.String DEVFMT_TYPEID
The key used to get the identifier of the device format type from the adapter configuration. The current value is "deviceFormatTypeId".
See Also:
Constant Field Values

DEVFMT_ENABLED

public static final java.lang.String DEVFMT_ENABLED
The key used to determine whether the adapter should be enabled or not. The current vlaue is "enabled".
See Also:
Constant Field Values

devfmtType

protected java.lang.String devfmtType

devfmtId

protected java.lang.Integer devfmtId

devfmtName

protected java.lang.String devfmtName

devfmtTypeId

protected java.lang.Integer devfmtTypeId

devfmtClass

protected java.lang.Class devfmtClass

isEnabled

protected boolean isEnabled
Constructor Detail

DeviceFormatAdapterDesc

public DeviceFormatAdapterDesc()
Reserved for IBM internal use. Creates the Device Format Adapter Descriptor object.
Method Detail

getDeviceFormatClass

public final java.lang.Class getDeviceFormatClass()
Reserved for IBM internal use. Returns a Class object that is used to instantiate an adapter describe by this adapter descriptor.
Returns:
The factor class of the adapter.

getDeviceFormatId

public final java.lang.Integer getDeviceFormatId()
Reserved for IBM internal use. Gets the device format identifier for this adapter.
Returns:
The device format identifier.

getDeviceFormatName

public final java.lang.String getDeviceFormatName()
Reserved for IBM internal use. Gets the device format name for this adapter.
Returns:
The device format name.

getDeviceFormatType

public final java.lang.String getDeviceFormatType()
Reserved for IBM internal use. Gets the name of the device format type for this adapter.
Returns:
The name of the device format type.

getDeviceFormatTypeId

public final java.lang.Integer getDeviceFormatTypeId()
Reserved for IBM internal use. Gets the device format type identifier for this adapter.
Returns:
The device format type identifier.

init

public void init(org.w3c.dom.Element node)
          throws java.lang.Exception
Reserved for IBM internal use. Initialize this descriptor based on information that is defined in a DOM node associated with this adapter.
Parameters:
node - a dom node associated with this adapter.
Throws:
java.lang.Exception - if there is any problems parsing the given DOM node.

isEnabled

public final boolean isEnabled()
Reserved for IBM internal use. Returns true if this adapter is enabled.
Returns:
Whether the adapter is enabled (true) or not (false).

setDeviceFormatClass

public final void setDeviceFormatClass(java.lang.Class value)
Reserved for IBM internal use. Sets the device format class for this adapter.
Parameters:
value - the class object associated with this adapter.

setDeviceFormatId

public final void setDeviceFormatId(java.lang.Integer value)
Reserved for IBM internal use. Sets the device format Identifier for this adapter.
Parameters:
value - the device format identifier.

setDeviceFormatName

public final void setDeviceFormatName(java.lang.String value)
Reserved for IBM internal use. Sets the device format name for this adapter.
Parameters:
value - the device format name.

setDeviceFormatType

public final void setDeviceFormatType(java.lang.String value)
Reserved for IBM internal use. Sets the name of the device format type for this adapter.
Parameters:
value - the name of the device format type.

setDeviceFormatTypeId

public final void setDeviceFormatTypeId(java.lang.Integer value)
Reserved for IBM internal use. Sets the identifier of the device format type for this adapter.
Parameters:
value - the identifier of the device format type.

setIsEnabled

public final void setIsEnabled(boolean value)
Reserved for IBM internal use. Sets the isEnabled flag for this this adapter.
Parameters:
value - whether the adapter should be enabled (true) or not (false).