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
Method Detail |
---|
public java.lang.Integer getDeviceFormatId()
public java.lang.String getDeviceFormatName()
public java.lang.String getDeviceFormatType()
public java.lang.Integer getDeviceFormatTypeId()
public java.lang.String getDocumentPathName(java.lang.String name)
name
- the base name for the output document.public TypedProperty getRequestProperties()
public SessionContext getSessionContext() throws ECException
ECException
- if there was a problem retrieving the session context.public void postInvokeCommand(CommandContext commandContext) throws ECException
commandContext
- the command context associated with the
command.ECException
- if there was a problem with the post invoke
functionality.public boolean preInvokeCommand(CommandContext commandContext) throws ECException
commandContext
- the command context associated with the
command.ECException
- if there wa a problem with the pre invoke functionality.public void setDeviceFormatId(java.lang.Integer value)
value
- the device format identifier.public void setDeviceFormatName(java.lang.String value)
value
- the device format name.public void setDeviceFormatType(java.lang.String value)
value
- the name of the device type.public void setDeviceFormatTypeId(java.lang.Integer value)
value
- the identifier of the device format
type.public boolean processErrorResponse(CommandContext commandContext, java.lang.Exception e) throws ECException
ECException
- if there is a problem when determining whether the error response is needed
or not.public boolean processResponse(CommandContext commandContext, TypedProperty resProp) throws ECException
commandContext
- the command context of the request.ECException
- if there is a problem when determining whether the response is needed or
not.public java.lang.Integer getDefaultDeviceFormatId()
public void setDefaultDeviceFormatId(java.lang.Integer value)
value
- the default device format
identifier.