psdi.webclient.controls

Class InboxPortlet

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.system.controller.DatasrcInstance

psdi.webclient.controls.PortletDataInstance

psdi.webclient.controls.InboxPortlet

All Implemented Interfaces:

java.lang.Cloneable

public class InboxPortlet
extends PortletDataInstance

Represents the control instance for Inbox Portlet in the Start Center application. It contains methods to get data needed for rendering the portlet.

Author:

KD Singh

Field Summary

Fields inherited from class psdi.webclient.system.controller.ControlInstance

amIinitialize, DATASOURCE, INPUTMODE, labelOverride, ONDATACAHNGE, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_LIGHTNING, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, RERENDER_PROPERTY

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
InboxPortlet()

Method Summary

Modifier and Type	Method and Description
MboValueData[][]	getAssignments() Returns inbox assignment data as mabo value data
java.lang.String	getDescTitle() Returns title of the description field which will always be shown
java.util.Vector	getInboxColumns() Returns a collection of the columns the user has selected to display
MboValueData[][]	getKeyAttributeData() Returns key attribute columns
java.lang.String[]	getLabels() Returns labels for this portlet.
java.lang.String	getLatestDate() Returns the complete name of the current logged use to display on the portlet
java.util.ArrayList	getNonPersistentColumns() Returns a collection of the columns that are non persistent
int	getNoOfAssignments() Returns No of assignments
MboSetInfo[]	getSetsInfo() Returns array, which MboSetInfo's, used by InboxPortlet to detrmine bidi attributes of displayed data.
java.lang.String	getSortAttribute(java.lang.String sortIndex) Return the attribute name for sorting given a column index
java.lang.String	getUserName() Returns the complete name of the current logged use to display on the portlet
int	openassignment() Opens the assignment, by opening app on which assigment was created.
int	routeassignment() Routes the assignment, by opening app on which assigment was created.

Methods inherited from class psdi.webclient.controls.PortletDataInstance

checkOrStoreCachedProperty, cleanup, createRenderData, deleteportlet, editportlet, filter, formatNumber, getAppBean, getAppId, getKPIImage, getLabels, getPortletCacheId, getStartCenterPane, getStateManager, hasData, initialize, instantiatedatasrc, isFiltered, isFilterOpen, isFilterToggled, isLinkedToKPI, isLinkedToReport, isMaximised, isPortletStateChanged, isPortletUpdated, isPortletVisible, openrecord, openreport, percentKPIMark, refreshdata, scroll, setFiltered, setFilterToggled, setHasData, setHasLinkedReportsOrKPIs, setPortletStateChanged, setPortletUpdated, sort, togglefilter, toggleportlet

Methods inherited from class psdi.webclient.system.controller.DatasrcInstance

broadcastEvent, getDataBean, instantiatedatasrcdesign, render

Methods inherited from class psdi.webclient.system.controller.ControlInstance

addChild, addComponent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, clearComponent, clearErrors, copy, createRenderId, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getConditonallyChanged, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getErrorLevel, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasVisibleChildren, isDesignerEditedProperty, isDisabled, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, moveChild, needsRender, parseParamvalues, preRender, preRenderChecks, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setNeedsRender, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, setVisibility, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getId, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, isOnTableRow, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InboxPortlet

public InboxPortlet()

Method Detail

getAssignments

public MboValueData[][] getAssignments()
                                throws MXException,
                                       java.rmi.RemoteException

Returns inbox assignment data as mabo value data

Parameters:

starting - index

end - index

Returns:

MboValueData[][]

Throws:

MXException

java.rmi.RemoteException

getSetsInfo

public MboSetInfo[] getSetsInfo()
                         throws MXException,
                                java.rmi.RemoteException

Returns array, which MboSetInfo's, used by InboxPortlet to detrmine bidi attributes of displayed data.

Returns:

MboSetInfo[]: [0] - InbxConfigSet for descriptions (excluding main description), [1] - WFAssignmentSet for data and main description.

Throws:

MXException

java.rmi.RemoteException

getNoOfAssignments

public int getNoOfAssignments()
                       throws MXException,
                              java.rmi.RemoteException

Returns No of assignments

Throws:

MXException

java.rmi.RemoteException

getKeyAttributeData

public MboValueData[][] getKeyAttributeData()
                                     throws MXException,
                                            java.rmi.RemoteException

Returns key attribute columns

Returns:

MboValueData[][]

Throws:

MXException

java.rmi.RemoteException

getInboxColumns

public java.util.Vector getInboxColumns()
                                 throws MXException,
                                        java.rmi.RemoteException

Returns a collection of the columns the user has selected to display

Returns:

vector of the columns the user has selected to display

Throws:

MXException

java.rmi.RemoteException - TODO: Take DESCRIPTION column temporary code to backend in method "getInboxColumns()";

getSortAttribute

public java.lang.String getSortAttribute(java.lang.String sortIndex)

Return the attribute name for sorting given a column index

Overrides:

getSortAttribute in class PortletDataInstance

Parameters:

colIndex -

Returns:

Attribute Name

getNonPersistentColumns

public java.util.ArrayList getNonPersistentColumns()
                                            throws MXException,
                                                   java.rmi.RemoteException

Returns a collection of the columns that are non persistent

Returns:

vector of the columns that are non persistent

Throws:

MXException

java.rmi.RemoteException

getUserName

public java.lang.String getUserName()

Returns the complete name of the current logged use to display on the portlet

getLatestDate

public java.lang.String getLatestDate()
                               throws java.rmi.RemoteException,
                                      MXException

Returns the complete name of the current logged use to display on the portlet

Throws:

java.rmi.RemoteException

MXException

getDescTitle

public java.lang.String getDescTitle()
                              throws java.rmi.RemoteException,
                                     MXException

Returns title of the description field which will always be shown

Throws:

java.rmi.RemoteException

MXException

getLabels

public java.lang.String[] getLabels()

Returns labels for this portlet. Following list shows list of keys to be used and the labels they stand for

Returns:

String array of locale specific labels

openassignment

public int openassignment()

Opens the assignment, by opening app on which assigment was created.

routeassignment

public int routeassignment()

Routes the assignment, by opening app on which assigment was created. The route process is external to this portlet and handled by the AppBean of the application the route goes to.