|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides the basic interface for a device format adapter.
Field Summary | |
static java.lang.String |
COPYRIGHT
|
Method Summary | |
java.lang.Integer |
getDefaultDeviceFormatId()
Returns the default device format identifier for this adapter |
java.lang.Integer |
getDeviceFormatId()
Returns the device format identifier for this adapter |
java.lang.String |
getDeviceFormatName()
Return the device format name. |
java.lang.String |
getDeviceFormatType()
Returns the device format type name such as Browser, PVCDevice |
java.lang.Integer |
getDeviceFormatTypeId()
Returns the device format type id for this adapter. |
java.lang.String |
getDocumentPathName(java.lang.String name)
Given a base document name, returns a actual document name based on the device |
TypedProperty |
getRequestProperties()
Returns the request parameters in a TypedProperty object. |
SessionContext |
getSessionContext()
Gets the session context. |
void |
postInvokeCommand(CommandContext commandContext)
This method implements adapter specific function after the execution of a command. |
boolean |
preInvokeCommand(CommandContext commandContext)
This method implements adapter specific function before the execution of a command. |
boolean |
processErrorResponse(CommandContext commandContext,
java.lang.Exception e)
This method is called by the web controller when the execution of a request has failed. |
boolean |
processResponse(CommandContext commandContext,
TypedProperty resProp)
This method is called by the web controller after it has successfully finished the execution of the request. |
void |
setDefaultDeviceFormatId(java.lang.Integer value)
Sets the device format Id. |
void |
setDeviceFormatId(java.lang.Integer value)
Sets the device format Id. |
void |
setDeviceFormatName(java.lang.String value)
Sets the device format name. |
void |
setDeviceFormatType(java.lang.String value)
Sets the input device type for this request. |
void |
setDeviceFormatTypeId(java.lang.Integer value)
Sets the device format type Id. |
Field Detail |
public static final java.lang.String COPYRIGHT
Method Detail |
public java.lang.Integer getDefaultDeviceFormatId()
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
- String - base name for the output documentpublic TypedProperty getRequestProperties()
public SessionContext getSessionContext() throws ECException
public void postInvokeCommand(CommandContext commandContext) throws ECException
commandContext
- CommandContext - the command context associated with the command.ECException
- public boolean preInvokeCommand(CommandContext commandContext) throws ECException
commandContext
- CommandContext - the command context associated with the command.ECException
- public boolean processErrorResponse(CommandContext commandContext, java.lang.Exception e) throws ECException
exception
- Exception - exception caught when executing the request.public boolean processResponse(CommandContext commandContext, TypedProperty resProp) throws ECException
respProperties
- TypedProperty - response properties returned by the command.public void setDefaultDeviceFormatId(java.lang.Integer value)
value
- java.lang.Integerpublic void setDeviceFormatId(java.lang.Integer value)
value
- java.lang.Integerpublic void setDeviceFormatName(java.lang.String value)
value
- java.lang.Stringpublic void setDeviceFormatType(java.lang.String value)
value
- java.lang.Stringpublic void setDeviceFormatTypeId(java.lang.Integer value)
value
- java.lang.Integer
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |