|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lumis.portal.serviceinterface.GenericServiceInterface lumis.doui.service.DouiServiceInterface
@StableMinor(version="6.2", sinceVersion="4.0") public class DouiServiceInterface
Base service interface implementation for the doui framework.
Field Summary | |
---|---|
static String |
VALIDATE_RENDER_PARAMETER
|
Constructor Summary | |
---|---|
DouiServiceInterface()
|
Method Summary | |
---|---|
protected boolean |
addDefaultControls(Node serviceInterfaceDouiDefinitionNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
void |
addDefaultDouiDefinitionValues(SessionConfig sessionConfig,
ServiceInterfaceConfig serviceInterfaceConfig,
Node douiDefinitionNode,
ITransaction transaction)
|
protected boolean |
addDefaultFields(Node serviceInterfaceSourceNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
protected boolean |
addDefaultFilters(Node serviceInterfaceSourceNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
protected boolean |
addDefaultHyperLinks(Node serviceInterfaceDouiDefinitionNode,
Node serviceDouiDefinitionNode,
ITransaction transaction)
|
protected Node |
addDefaultInterfaceDouiDefinitionNode(String serviceInterfaceId,
Node serviceDouiDefinitionNode)
|
protected boolean |
addDefaultMaxRows(Node serviceInterfaceSourceNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
protected boolean |
addDefaultOrderBy(Node serviceInterfaceSourceNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
protected boolean |
addDefaultPostLoadProcessors(Node serviceInterfaceSourceNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
Adds the default post load processors to the given source node. |
protected boolean |
addDefaultProcessActions(Node serviceInterfaceDouiDefinitionNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
protected boolean |
addDefaultSources(Node serviceInterfaceDouiDefinitionNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
protected boolean |
addDetailsHyperLink(Node serviceInterfaceDouiDefinitionNode,
Node serviceDouiDefinitionNode,
ITransaction transaction)
|
protected boolean |
addPrimaryKeyFilter(Node serviceInterfaceSourceNode,
Node serviceDouiDefinitionNode,
Node serviceInterfaceXmlNode)
|
protected DouiContext |
getContext(IServiceInterfaceRequest request,
IServiceInterfaceResponse response,
ITransaction transaction)
Instantiate DouiContext with the current request and response. |
protected String |
getCustomMenu(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig config,
ITransaction transaction)
|
protected String |
getDefaultStyle()
|
protected Node |
getInterfaceSourceFieldsNode(Node serviceDouiDefinitionNode,
Node serviceInterfaceSourceNode)
Utility method that merges the fields in the given nodes and returns the merged resultant node. |
Node |
getMenu(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig config,
ITransaction transaction)
|
String |
getRepositoryMenus(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig config,
ITransaction transaction)
|
protected void |
initDouiContext(DouiContext douiContext)
Initialize the Doui context, source container and control container. |
protected void |
loadFromRequest(DouiContext douiContext)
Load controls from request. |
protected void |
loadSources(DouiContext douiContext)
Load sources. |
void |
processAction(IServiceInterfaceActionRequest request,
IServiceInterfaceActionResponse response)
Called by the service interface container to allow the service interface to process an action request. |
protected void |
processActions(DouiContext douiContext)
Process actions. |
void |
register(SessionConfig sessionConfig,
Node serviceInterfaceXmlNode,
ITransaction transaction)
Called by the service interface manager when a service interface definition is registered. |
void |
render(IServiceInterfaceRenderRequest request,
IServiceInterfaceRenderResponse response)
Called by the service interface container to allow the service interface to generate the content of the response based on its current state. |
void |
renderBefore(IServiceInterfaceRenderRequest request,
IServiceInterfaceRenderResponse response)
Called by the service interface container before rendering the interface client side. |
protected void |
renderData(IServiceInterfaceRenderResponse response,
DouiContext douiContext)
Render data. |
protected boolean |
validate(DouiContext douiContext)
Executes the controls validation. |
Methods inherited from class lumis.portal.serviceinterface.GenericServiceInterface |
---|
instanceAdded, instanceDeleted, instanceLoaded, instanceUnLoaded, load, unload |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String VALIDATE_RENDER_PARAMETER
Constructor Detail |
---|
public DouiServiceInterface()
Method Detail |
---|
protected DouiContext getContext(IServiceInterfaceRequest request, IServiceInterfaceResponse response, ITransaction transaction) throws PortalException
request
- the request being processed.response
- the response being constructed.transaction
- the current transaction.
PortalException
- if an error occur constructing DouiContext.protected void initDouiContext(DouiContext douiContext) throws PortalException
request
- the request being processed.response
- the response instance.
PortalException
- if an error occur during the initialization process.protected void loadFromRequest(DouiContext douiContext) throws PortalException
douiContext
- an instance of DouiContext.
PortalException
- if an error occur.protected boolean validate(DouiContext douiContext) throws PortalException
douiContext
- the DouiContext instance.
PortalException
- if an error occur.protected void loadSources(DouiContext douiContext) throws PortalException
douiContext
- the DouiDefinition instance.
PortalException
- if an error occur.protected void renderData(IServiceInterfaceRenderResponse response, DouiContext douiContext) throws PortalException
douiContext
- DouiContext instance.
PortalException
- if an error occur during the render process.protected void processActions(DouiContext douiContext) throws PortalException
douiContext
- instance of DouiContext.request
- the request being processed.response
- the response instance.controlsValidated
- indicates if the controls are valid.
PortalException
- if an error occur during the action process.public void render(IServiceInterfaceRenderRequest request, IServiceInterfaceRenderResponse response) throws ServiceInterfaceException, PortalException
Executes the following steps (implemented by the referenced methods):
getContext(IServiceInterfaceRequest, IServiceInterfaceResponse, ITransaction)
initDouiContext(DouiContext)
loadFromRequest(DouiContext)
validate(DouiContext)
loadSources(DouiContext)
renderData(IServiceInterfaceRenderResponse, DouiContext)
render
in interface IServiceInterface
render
in class GenericServiceInterface
request
- the render requestresponse
- the render response
ServiceInterfaceException
- if the service interface has problems fulfilling the rendering request
PortalException
- if the service interface is unavailable to perform render at this timepublic void processAction(IServiceInterfaceActionRequest request, IServiceInterfaceActionResponse response) throws ServiceInterfaceException, PortalException
RenderResponse.createActionURL()
method.
Typically, in response to an action request, a service interface updates state based on the information sent in the action request parameters. In an action the service interface may:
A client request triggered by an action URL translates into one action request and many render requests, one per service interface in the portal page. The action processing must be finished before the render requests can be issued.
Execute the following steps (implemented by the referenced methods):
getContext(IServiceInterfaceRequest, IServiceInterfaceResponse, ITransaction)
initDouiContext(DouiContext)
loadFromRequest(DouiContext)
validate(DouiContext)
processActions(DouiContext)
processAction
in interface IServiceInterface
processAction
in class GenericServiceInterface
request
- the action requestresponse
- the action response
ServiceInterfaceException
- if the service interface has problems fulfilling the request
PortalException
- if the service interface is unavailable to process the action at this timepublic void renderBefore(IServiceInterfaceRenderRequest request, IServiceInterfaceRenderResponse response) throws ServiceInterfaceException, PortalException
Execute the following steps (implemented by the referenced methods):
getContext(IServiceInterfaceRequest, IServiceInterfaceResponse, ITransaction)
initDouiContext(DouiContext)
renderData(IServiceInterfaceRenderResponse, DouiContext)
renderBefore
in interface IServiceInterface
renderBefore
in class GenericServiceInterface
request
- the render requestresponse
- the render response
ServiceInterfaceException
- if the service interface has problems fulfilling the rendering request
PortalException
- if the service interface is unavailable to perform render at this timeprotected String getDefaultStyle()
public Node getMenu(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig config, ITransaction transaction) throws PortalException
getMenu
in interface IServiceInterfaceMenu
PortalException
protected String getCustomMenu(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig config, ITransaction transaction) throws PortalException
PortalException
public String getRepositoryMenus(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig config, ITransaction transaction) throws PortalException
PortalException
public void register(SessionConfig sessionConfig, Node serviceInterfaceXmlNode, ITransaction transaction) throws PortalException
IServiceInterface
register
in interface IServiceInterface
register
in class GenericServiceInterface
sessionConfig
- TODOtransaction
- TODO
PortalException
public void addDefaultDouiDefinitionValues(SessionConfig sessionConfig, ServiceInterfaceConfig serviceInterfaceConfig, Node douiDefinitionNode, ITransaction transaction) throws PortalException
addDefaultDouiDefinitionValues
in interface IDouiServiceInterface
PortalException
protected Node getInterfaceSourceFieldsNode(Node serviceDouiDefinitionNode, Node serviceInterfaceSourceNode) throws PortalException
serviceDouiDefinitionNode
- the service doui definition node.serviceInterfaceSourceNode
- the service interface source node.
PortalException
protected Node addDefaultInterfaceDouiDefinitionNode(String serviceInterfaceId, Node serviceDouiDefinitionNode) throws PortalException
PortalException
protected boolean addDefaultSources(Node serviceInterfaceDouiDefinitionNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
protected boolean addDefaultFields(Node serviceInterfaceSourceNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
protected boolean addDefaultFilters(Node serviceInterfaceSourceNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
protected boolean addDefaultOrderBy(Node serviceInterfaceSourceNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
protected boolean addDefaultMaxRows(Node serviceInterfaceSourceNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
protected boolean addDefaultPostLoadProcessors(Node serviceInterfaceSourceNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
serviceInterfaceSourceNode
- the service interface source node.serviceDouiDefinitionNode
- the service doui definition node.serviceInterfaceXmlNode
- the interface doui definition node.
PortalException
protected boolean addDefaultControls(Node serviceInterfaceDouiDefinitionNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
protected boolean addDefaultHyperLinks(Node serviceInterfaceDouiDefinitionNode, Node serviceDouiDefinitionNode, ITransaction transaction) throws PortalException
PortalException
protected boolean addDefaultProcessActions(Node serviceInterfaceDouiDefinitionNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
protected boolean addDetailsHyperLink(Node serviceInterfaceDouiDefinitionNode, Node serviceDouiDefinitionNode, ITransaction transaction) throws PortalException
PortalException
protected boolean addPrimaryKeyFilter(Node serviceInterfaceSourceNode, Node serviceDouiDefinitionNode, Node serviceInterfaceXmlNode) throws PortalException
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |