curam.contextviewer.facade.intf

Interface ContextFacade

All Known Implementing Classes:

ContextFacade, curam.contextviewer.facade.impl.ContextFacade, ContextFacadeFactory

@AccessLevel(value=EXTERNAL)
public interface ContextFacade

Facade for interaction between the citizen context viewer client and server.

Method Summary

Modifier and Type	Method and Description
curam.contextviewer.facade.struct.ContextDetails	getContextDetails(curam.contextviewer.facade.struct.Context_ID contextID) Returns the context details used to show data in the Citizen Context Viewer.
curam.contextviewer.facade.struct.ContextRenderer	launchViewer(curam.contextviewer.facade.struct.Context_ID context_ID) Returns a context id based on the context viewer domain.
curam.contextviewer.facade.struct.ContextNodeTypeDetails	readContextNodeTypes() Returns the context node types that define the nature of the context tree in the citizen context tree.
curam.contextviewer.facade.struct.ContextTree	readContextTree(curam.contextviewer.facade.struct.Context_ID context_ID) Returns the context tree to be displayed in the Citizen Context Viewer.

Method Detail

getContextDetails

curam.contextviewer.facade.struct.ContextDetails getContextDetails(curam.contextviewer.facade.struct.Context_ID contextID)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Returns the context details used to show data in the Citizen Context Viewer.

Parameters:

contextID - The identifier of the context to be displayed.

Returns:

ContextDetails The widget specific details for the Citizen Context Viewer.

Throws:

AppException - @exception InformationalException.

curam.util.exception.InformationalException

readContextNodeTypes

curam.contextviewer.facade.struct.ContextNodeTypeDetails readContextNodeTypes()
                                                                       throws curam.util.exception.AppException,
                                                                              curam.util.exception.InformationalException

Returns the context node types that define the nature of the context tree in the citizen context tree.

Returns:

ContextNodeTypeDetails The details for the context node types that exist for the citizen context viewer.

Throws:

AppException

InformationalException.

curam.util.exception.InformationalException

readContextTree

curam.contextviewer.facade.struct.ContextTree readContextTree(curam.contextviewer.facade.struct.Context_ID context_ID)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Returns the context tree to be displayed in the Citizen Context Viewer.

Parameters:

context_ID - The identifier of the context to be displayed.

Returns:

ContextTree Holding widget specific details for the context tree display in the Citizen Context Viewer.

Throws:

AppException - @exception InformationalException.

curam.util.exception.InformationalException

launchViewer

curam.contextviewer.facade.struct.ContextRenderer launchViewer(curam.contextviewer.facade.struct.Context_ID context_ID)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Returns a context id based on the context viewer domain.

Parameters:

context_ID - The id of the context to be displayed.

Returns:

The context id value mapped to the context viewer widget domain.

Throws:

AppException

curam.util.exception.InformationalException