com.ibm.commerce.adapter
Interface DeviceFormatAdapter

All Known Subinterfaces:
HttpAdapter, HttpAdapterFactory, PVCAdapter
All Known Implementing Classes:
AbstractHttpAdapter, HttpProgramAdapterImpl, PVCAdapterImpl

public interface DeviceFormatAdapter

Reserved for IBM internal use. Provides the basic interface for a device format adapter.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
 
Method Summary
 java.lang.Integer getDefaultDeviceFormatId()
          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.
 java.lang.String getDocumentPathName(java.lang.String name)
          Reserved for IBM internal use.
  TypedProperty getRequestProperties()
          Reserved for IBM internal use.
  SessionContext getSessionContext()
          Reserved for IBM internal use.
 void postInvokeCommand( CommandContext commandContext)
          Reserved for IBM internal use.
 boolean preInvokeCommand( CommandContext commandContext)
          Reserved for IBM internal use.
 boolean processErrorResponse( CommandContext commandContext, java.lang.Exception e)
          Reserved for IBM internal use.
 boolean processResponse( CommandContext commandContext, TypedProperty resProp)
          Reserved for IBM internal use.
 void setDefaultDeviceFormatId(java.lang.Integer 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.
 

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

getDeviceFormatId

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

getDeviceFormatName

public java.lang.String getDeviceFormatName()
Reserved for IBM internal use. Return the device format name, for example, "Browser".
Returns:
The device format name.

getDeviceFormatType

public java.lang.String getDeviceFormatType()
Reserved for IBM internal use. Returns the name of the device format type, for example, "Browser" or "PVCDevice".
Returns:
The name of the device format type.

getDeviceFormatTypeId

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

getDocumentPathName

public java.lang.String getDocumentPathName(java.lang.String name)
Reserved for IBM internal use. Given a base document name, returns a actual document name based on the device and the given document name.
Parameters:
name - the base name for the output document.
Returns:
The name of the actual document to return.

getRequestProperties

public TypedProperty getRequestProperties()
Reserved for IBM internal use. Returns the request parameters of the device for a particular request.
Returns:
The request properties.

getSessionContext

public SessionContext getSessionContext()
                                 throws ECException
Reserved for IBM internal use. Gets the session context.
Returns:
The session context of the device for a particular request.
Throws:
ECException - if there was a problem retrieving the session context.

postInvokeCommand

public void postInvokeCommand(CommandContext commandContext)
                       throws ECException
Reserved for IBM internal use. This method implements adapter specific function after the execution of a command.
Parameters:
commandContext - the command context associated with the command.
Throws:
ECException - if there was a problem with the post invoke functionality.

preInvokeCommand

public boolean preInvokeCommand(CommandContext commandContext)
                         throws ECException
Reserved for IBM internal use. This method implements adapter specific function before the execution of a command.
Parameters:
commandContext - the command context associated with the command.
Returns:
Whether to continue with the execution of the request.
Throws:
ECException - if there wa a problem with the pre invoke functionality.

setDeviceFormatId

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

setDeviceFormatName

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

setDeviceFormatType

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

setDeviceFormatTypeId

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

processErrorResponse

public boolean processErrorResponse(CommandContext commandContext,
                                    java.lang.Exception e)
                             throws ECException
Reserved for IBM internal use. This method is called by the web controller when the execution of a request has failed. The web controller will execute the error view task associated with the exeception if this method returns true.
Returns:
Whether to process the error response.
Throws:
ECException - if there is a problem when determining whether the error response is needed or not.

processResponse

public boolean processResponse(CommandContext commandContext,
TypedProperty resProp)
                        throws ECException
Reserved for IBM internal use. This method is called by the web controller after it has successfully finished the execution of the request. The web controller will execute the view task associated with the command if this method returns true.
Parameters:
commandContext - the command context of the request.
Returns:
Whether to process the response of the request.
Throws:
ECException - if there is a problem when determining whether the response is needed or not.

getDefaultDeviceFormatId

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

setDefaultDeviceFormatId

public void setDefaultDeviceFormatId(java.lang.Integer value)
Reserved for IBM internal use. Sets the default device format identifier.
Parameters:
value - the default device format identifier.