|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class allows you to customize the look and feel of certain parts of
the Web Client. This is done by implementing various
commandResponse
methods that must create response pages
for certain client requests (command).
If you want to customize only certain elements of the Web Client you should
extend the DefaultViewer
class in order to inherit the
default behaviour for the parts that you do not override.
You must set the
DefaultViewer property
in the WebClient.properties
file to use a viewer other than
DefaultViewer
.
Method Summary | |
---|---|
ResponsePage |
cancelWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.cancelWorkItem() command. |
ResponsePage |
checkInWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.checkInWorkItem() command. |
ResponsePage |
checkOutWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.checkOutWorkItem() command. |
ResponsePage |
createAndStartInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.createAndStartInstance() command. |
ResponsePage |
createInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.createInstance() command. |
ResponsePage |
createListResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.createList() command. |
ResponsePage |
createPersistentListResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.createPersistentList() command. |
ResponsePage |
deleteInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.deleteInstance() command. |
ResponsePage |
deleteItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.deleteItem() command. |
ResponsePage |
deleteListResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.deleteList() command. |
ResponsePage |
deleteTemplateResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.deleteTemplate() command. |
ResponsePage |
errorResponse(RequestContext context)
This method is called by the Web Client if an error occurred. |
ResponsePage |
finishWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.finishWorkItem() command. |
ResponsePage |
forceFinishActivityResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.forceFinishActivity() command. |
ResponsePage |
forceFinishWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.forceFinishWorkItem() command. |
ResponsePage |
forceRestartActivityResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.forceRestartActivity() command. |
ResponsePage |
forceRestartWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.forceRestartWorkItem() command. |
ResponsePage |
getFilterAssistantResponse(RequestContext context)
Deprecated. - this function will be redesigned in a later release |
ResponsePage |
getSystemInfoResponse(RequestContext context)
Deprecated. - this function will be redesigned in a later release |
ResponsePage |
getUserInfoResponse(RequestContext context)
Deprecated. - this function will be redesigned in a later release |
void |
init(Config config)
This method is called after the Web Client's servlet has been initialized. |
ResponsePage |
logoffResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.logoff() command. |
ResponsePage |
logonResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.logon() command. |
ResponsePage |
queryListsResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.queryLists() command. |
ResponsePage |
queryProcessInstancesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.queryProcessInstances() command. |
ResponsePage |
queryProcessTemplatesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.queryProcessTemplates() command. |
ResponsePage |
queryWorkItemsResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.queryWorkItems() command. |
ResponsePage |
restartInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.restartInstance() command. |
ResponsePage |
restartWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.restartWorkItem() command. |
ResponsePage |
resumeInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.resumeInstance() command. |
ResponsePage |
setListPropertiesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.setListProperties() command. |
ResponsePage |
setUserSettingsResponse(RequestContext context)
Deprecated. - this function will be redesigned in a later release |
ResponsePage |
setViewSettingsResponse(RequestContext context)
Deprecated. - this function will be redesigned in a later release |
ResponsePage |
showActivityPropertiesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.showActivityProperties() command. |
ResponsePage |
showControlConnectorPropertiesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.showControlConnectorProperties() command. |
ResponsePage |
showInstancePropertiesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.showInstanceProperties() command. |
ResponsePage |
showListPropertiesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.showListProperties() command. |
ResponsePage |
showTemplatePropertiesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.showTemplateProperties() command. |
ResponsePage |
showWorkItemPropertiesResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.showWorkItemProperties() command. |
ResponsePage |
startInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.startInstance() command. |
ResponsePage |
startWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.startWorkItem() command. |
ResponsePage |
suspendInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.suspendInstance() command. |
ResponsePage |
terminateActivityResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.terminateActivity() command. |
ResponsePage |
terminateInstanceResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.terminateInstance() command. |
ResponsePage |
terminateWorkItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.terminateWorkItem() command. |
ResponsePage |
transferItemResponse(RequestContext context)
This method is called to create the response page for the BuiltinHandler.transferItem() command. |
Method Detail |
public void init(Config config)
DefaultViewer.java
.config
- The servlet's configuration and initialization parameterspublic ResponsePage errorResponse(RequestContext context)
context.getException()
method.context
- The request context.public ResponsePage logonResponse(RequestContext context) throws ClientException
BuiltinHandler.logon()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage logoffResponse(RequestContext context)
BuiltinHandler.logoff()
command.
This method is called by the Web Client after the user has logged off.context
- The request context.public ResponsePage queryListsResponse(RequestContext context) throws ClientException
BuiltinHandler.queryLists()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage showListPropertiesResponse(RequestContext context) throws ClientException
BuiltinHandler.showListProperties()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage setListPropertiesResponse(RequestContext context) throws ClientException
BuiltinHandler.setListProperties()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage createListResponse(RequestContext context) throws ClientException
BuiltinHandler.createList()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage createPersistentListResponse(RequestContext context) throws ClientException
BuiltinHandler.createPersistentList()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage deleteListResponse(RequestContext context) throws ClientException
BuiltinHandler.deleteList()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage queryProcessTemplatesResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessTemplates()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage showTemplatePropertiesResponse(RequestContext context) throws ClientException
BuiltinHandler.showTemplateProperties()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage createInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.createInstance()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage createAndStartInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.createAndStartInstance()
command.
If the request parameter (see
RequestContext.getRequestParameter
)
id
is set, then the process instance has been created from a
process template list. If the request parameter templateName
is set, then the process instance has been started from the
web user.context
- The request context.ClientException
- If an error occurred.public ResponsePage deleteTemplateResponse(RequestContext context) throws ClientException
BuiltinHandler.deleteTemplate()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage queryProcessInstancesResponse(RequestContext context) throws ClientException
BuiltinHandler.queryProcessInstances()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage showInstancePropertiesResponse(RequestContext context) throws ClientException
BuiltinHandler.showInstanceProperties()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage deleteInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.deleteInstance()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage startInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.startInstance()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage suspendInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.suspendInstance()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage resumeInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.resumeInstance()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage terminateInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.terminateInstance()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage restartInstanceResponse(RequestContext context) throws ClientException
BuiltinHandler.restartInstance()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage showActivityPropertiesResponse(RequestContext context) throws ClientException
BuiltinHandler.showActivityProperties()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage forceRestartActivityResponse(RequestContext context) throws ClientException
BuiltinHandler.forceRestartActivity()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage forceFinishActivityResponse(RequestContext context) throws ClientException
BuiltinHandler.forceFinishActivity()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage terminateActivityResponse(RequestContext context) throws ClientException
BuiltinHandler.terminateActivity()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage showControlConnectorPropertiesResponse(RequestContext context) throws ClientException
BuiltinHandler.showControlConnectorProperties()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage queryWorkItemsResponse(RequestContext context) throws ClientException
BuiltinHandler.queryWorkItems()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage showWorkItemPropertiesResponse(RequestContext context) throws ClientException
BuiltinHandler.showWorkItemProperties()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage checkOutWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.checkOutWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage checkInWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.checkInWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage cancelWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.cancelWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage finishWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.finishWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage forceFinishWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.forceFinishWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage startWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.startWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage restartWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.restartWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage forceRestartWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.forceRestartWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage terminateWorkItemResponse(RequestContext context) throws ClientException
BuiltinHandler.terminateWorkItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage deleteItemResponse(RequestContext context) throws ClientException
BuiltinHandler.deleteItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage transferItemResponse(RequestContext context) throws ClientException
BuiltinHandler.transferItem()
command.context
- The request context.ClientException
- If an error occurred.public ResponsePage setUserSettingsResponse(RequestContext context) throws ClientException
public ResponsePage setViewSettingsResponse(RequestContext context) throws ClientException
public ResponsePage getFilterAssistantResponse(RequestContext context) throws ClientException
public ResponsePage getUserInfoResponse(RequestContext context) throws ClientException
public ResponsePage getSystemInfoResponse(RequestContext context) throws ClientException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |