Maximo 7.6 API - BulletinBoard

java.lang.Object
- psdi.webclient.system.controller.BaseInstance
- - psdi.webclient.system.controller.ControlInstance
  - - psdi.webclient.system.controller.DatasrcInstance
    - - psdi.webclient.controls.HyperLink
      - psdi.webclient.controls.BulletinBoard

All Implemented Interfaces:

java.lang.Cloneable
```
public class BulletinBoard
extends HyperLink
```
This bean acts as the control data source instance for bulletin board component and gets data for the current bulletin board. This class is designed to serve common purpose for bulletin board dialog and bulletin board portlet.

Author:

Venkyg : Note

Field Summary
- Fields inherited from class psdi.webclient.system.controller.ControlInstance
  amIinitialize, DATASOURCE, INPUTMODE, labelOverride, ONDATACAHNGE, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, 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

BulletinBoard()

Constructors
Constructor and Description
`BulletinBoard()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`bbmsgviewed()` Call from jsp once the BB message is clicked in start center
`int`	`clearfilter()` Removes the QBEs on the result set
`int`	`deleteportlet()` This event is only fired when this control is inside a portlet.
`void`	`filter()` Flags the portlet as filtered and refresable.
`java.lang.String`	`getBBSetName()`
`MboSetData`	`getData_old()`
`MboSetData`	`getData()`
`java.lang.String`	`getIsViewedValue()`
`java.lang.String[]`	`getLabels()` Returns labels for this control.
`int`	`getNoOfRecords()` Returns No of records Venkyg: 4/3/2009
`java.lang.String`	`getQbeSetting(java.lang.String attribName)` Returns the qbes set on the result set
`MboSetData`	`getRenderData()` Called from portlet to return data
`MboSetData`	`getResultSet()` It is new filter functionality for BB Messages in start center.
`java.util.Vector`	`getResultSetAttributes()` Returns a collection of the columns the user has selected to display the result set for
`PortletStateImpl`	`getStateManager()` Returns statemanaget when this control is used as a portlet
`java.util.List`	`getUnViewedMessages()` This method gets all Un Viewd messages from BBoardMsgStatus MBO
`java.util.List`	`getViewedMessageIdList()` This method gets all Viewd messages from BBoardMsgStatus MBO Used in Jsp
`boolean`	`hasData()` Returns true if there are messages in the BulletinBoard
`void`	`initialize()` Overridden to attach the count of bulletin messages to the label when the control is inside the bulletinBoard portlet
`boolean`	`isFiltered()`
`java.lang.String`	`isFilterOpen()` Returns whether filter panel is open
`boolean`	`isFilterSet()` Returns true if filter is set on this portlet
`boolean`	`isFilterToggled()`
`boolean`	`isPortlet()` Returns true if this is an instance of bulletinboardportlet control
`boolean`	`isPortletStateChanged()`
`int`	`msgCountForIcon()`
`int`	`refreshbytimer()` Sets control needing render if it was makred for refresh based on javascript timer.
`boolean`	`refreshedByTimer()` Returns true if marked true for refresh based on timer
`int`	`render()` Overridden to prevent render if inside hyperlink and no messages to show.
`void`	`resetflags()` Sets portlet flags
`void`	`setFiltered(boolean newFlag)`
`void`	`setFilterToggled(boolean flag)`
`void`	`setIconProperties()`
`void`	`setIsViewedValue(java.lang.String isViewedValue)`
`void`	`setPortletStateChanged(boolean newPortletState)`
`void`	`setqbeandfilter()` This method handles the "setqbeandfilter" event where use enters a qbe and presses the enter key
`void`	`setQbes(java.lang.String qbeKeyValuePair)` Stores the qbe done on the result set portlet graph
`void`	`setRefreshedByTimer(boolean flag)` Resets the time flag.
`int`	`setvalue()` This method handles the "setqbe" event where use enters a qbe and tabs out
`void`	`togglefilter()` Simply toggles the expanded state of the section

Methods inherited from class psdi.webclient.system.controller.DatasrcInstance
broadcastEvent, cleanup, getDataBean, instantiatedatasrc, instantiatedatasrcdesign

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, 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
  - BulletinBoard
```
public BulletinBoard()
```
- Method Detail
  - initialize
```
public void initialize()
```
    Overridden to attach the count of bulletin messages to the label when the control is inside the bulletinBoard portlet
    
    Overrides:
    
    initialize in class HyperLink
    
    See Also:
    BaseInstance.initialize()
  - getResultSet
```
public MboSetData getResultSet()
                        throws MXException,
                               java.rmi.RemoteException
```
    It is new filter functionality for BB Messages in start center.
    
    Parameters:
    starting - index -- latter
    end - index -- latter
    
    Returns:
    MboValueData[][]
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setQbes
```
public void setQbes(java.lang.String qbeKeyValuePair)
```
    Stores the qbe done on the result set portlet graph
    
    Parameters:
    attributeName -
    qbeExpression -
  - isFilterSet
```
public boolean isFilterSet()
```
    Returns true if filter is set on this portlet
  - setqbeandfilter
```
public void setqbeandfilter()
```
    This method handles the "setqbeandfilter" event where use enters a qbe and presses the enter key
  - getLabels
```
public java.lang.String[] getLabels()
```
    Returns labels for this control. Following list shows list of keys to be used and the labels they stand for
    - nobbmessages - No Bulletin Board Messages
    Returns:
    String array of locale specific labels
  - hasData
```
public boolean hasData()
```
    Returns true if there are messages in the BulletinBoard
    
    Returns:
    boolean
  - deleteportlet
```
public int deleteportlet()
```
    This event is only fired when this control is inside a portlet. Deletes portlet and its control instance.
  - render
```
public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException
```
    Overridden to prevent render if inside hyperlink and no messages to show. Important : This method used for Bulletins: header message-Icon before Go To, Every pages in Maximo
    
    Overrides:
    
    render in class HyperLink
    
    Throws:
    
    java.lang.NoSuchMethodException
    
    java.lang.IllegalAccessException
    
    java.lang.reflect.InvocationTargetException
    See Also:
    ControlInstance.render()
  - setIconProperties
```
public void setIconProperties()
```
  - getData
```
public MboSetData getData()
```
  - getData_old
```
public MboSetData getData_old()
```
  - refreshbytimer
```
public int refreshbytimer()
```
    Sets control needing render if it was makred for refresh based on javascript timer.
    
    Returns:
    int
  - refreshedByTimer
```
public boolean refreshedByTimer()
```
    Returns true if marked true for refresh based on timer
    
    Returns:
    boolean
  - setRefreshedByTimer
```
public void setRefreshedByTimer(boolean flag)
```
    Resets the time flag.
    
    Parameters:
    flag -
  - getBBSetName
```
public java.lang.String getBBSetName()
                              throws MXException,
                                     java.rmi.RemoteException
```
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getResultSetAttributes
```
public java.util.Vector getResultSetAttributes()
                                        throws MXException,
                                               java.rmi.RemoteException
```
    Returns a collection of the columns the user has selected to display the result set for
    
    Returns:
    vector of the columns the user has selected to display the result set for
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getQbeSetting
```
public java.lang.String getQbeSetting(java.lang.String attribName)
```
    Returns the qbes set on the result set
    
    Returns:
    String as the qbe setting
  - isFiltered
```
public boolean isFiltered()
```
    Returns:
    boolean - Returns true if the data was filtered.
  - setFiltered
```
public void setFiltered(boolean newFlag)
```
    Parameters:
    boolean - - Sets new flag for portlet data being filtered
  - clearfilter
```
public int clearfilter()
```
    Removes the QBEs on the result set
    
    Returns:
  - bbmsgviewed
```
public void bbmsgviewed()
                 throws MXException,
                        java.rmi.RemoteException
```
    Call from jsp once the BB message is clicked in start center
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getViewedMessageIdList
```
public java.util.List getViewedMessageIdList()
                                      throws MXException,
                                             java.rmi.RemoteException
```
    This method gets all Viewd messages from BBoardMsgStatus MBO Used in Jsp
    
    Returns:
    List
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getUnViewedMessages
```
public java.util.List getUnViewedMessages()
                                   throws MXException,
                                          java.rmi.RemoteException
```
    This method gets all Un Viewd messages from BBoardMsgStatus MBO
    
    Returns:
    List
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getIsViewedValue
```
public java.lang.String getIsViewedValue()
```
  - setIsViewedValue
```
public void setIsViewedValue(java.lang.String isViewedValue)
```
  - getNoOfRecords
```
public int getNoOfRecords()
                   throws MXException,
                          java.rmi.RemoteException
```
    Returns No of records Venkyg: 4/3/2009
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - msgCountForIcon
```
public int msgCountForIcon()
                    throws MXException,
                           java.rmi.RemoteException
```
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - isFilterToggled
```
public boolean isFilterToggled()
```
    Returns:
    boolean - Returns the filterToggled.
  - togglefilter
```
public void togglefilter()
```
    Simply toggles the expanded state of the section
  - isFilterOpen
```
public java.lang.String isFilterOpen()
```
    Returns whether filter panel is open
    
    Returns:
    String - "true" if filter panel is open
  - setFilterToggled
```
public void setFilterToggled(boolean flag)
```
  - isPortletStateChanged
```
public boolean isPortletStateChanged()
```
    Returns:
    boolean - Returns true if the portlet's state was changed
  - setPortletStateChanged
```
public void setPortletStateChanged(boolean newPortletState)
```
    Parameters:
    boolean - - Takes new flag for occurance of portlet delete event
  - setvalue
```
public int setvalue()
```
    This method handles the "setqbe" event where use enters a qbe and tabs out
  - resetflags
```
public void resetflags()
```
    Sets portlet flags
  - getRenderData
```
public MboSetData getRenderData()
```
    Called from portlet to return data
    
    Returns:
    MboSetData
  - filter
```
public void filter()
```
    Flags the portlet as filtered and refresable.
  - getStateManager
```
public PortletStateImpl getStateManager()
```
    Returns statemanaget when this control is used as a portlet
    
    Returns:
  - isPortlet
```
public boolean isPortlet()
```
    Returns true if this is an instance of bulletinboardportlet control
    
    Returns:
    boolean

Class BulletinBoard

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

BulletinBoard

Method Detail

initialize

getResultSet

setQbes

isFilterSet

setqbeandfilter

getLabels

hasData

deleteportlet

render

setIconProperties

getData

getData_old

refreshbytimer

refreshedByTimer

setRefreshedByTimer

getBBSetName

getResultSetAttributes

getQbeSetting

isFiltered

setFiltered

clearfilter

bbmsgviewed

getViewedMessageIdList

getUnViewedMessages

getIsViewedValue

setIsViewedValue

getNoOfRecords

msgCountForIcon

isFilterToggled

togglefilter

isFilterOpen

setFilterToggled

isPortletStateChanged

setPortletStateChanged

setvalue

resetflags

getRenderData

filter

getStateManager

isPortlet