ManufacturerRequestManager (Cable Database 5.4.1 API)

java.lang.Object
- org.openepics.cable.ui.ManufacturerRequestManager

All Implemented Interfaces:

Serializable, SimpleTableExporterFactory
```
public class ManufacturerRequestManager
extends Object
implements Serializable, SimpleTableExporterFactory
```
This is the backing requests bean for manufacturers.xhtml.

Author:

Sunil Sah

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ManufacturerRequestManager()
Constructs the controller bean and handles one time setup.

Constructors
Constructor and Description
`ManufacturerRequestManager()` Constructs the controller bean and handles one time setup.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkManufacturersForDeletion()` The method builds a list of manufacturers that are already deleted.
`void`	`clearSelectedManufacturers()` Clears the current manufacturer selection.
`void`	`clearSelection()` Clears the newly created selected manufacturer so editing is disabled
`List<String>`	`completeFilter(String query)` Provide suggestions for manufacturer given query to filter for.
`void`	`excuteQueryId(long id)` Execute query with given id.
`void`	`executeQuery(javax.faces.event.ActionEvent e)` Execute selected query.
`List<ManufacturerColumnUI>`	`getColumns()` Returns current columns to show in manufacturer data table
`String`	`getDateFormatString()`
`List<ManufacturerUI>`	`getDeletedManufacturers()`
`boolean`	`getEditManufacturer()`
`List<ManufacturerUI>`	`getFilteredManufacturers()`
`boolean`	`getIsAddPopupOpened()`
`String`	`getLongTextOverlayContent()` Gets overlay content text.
`String`	`getLongTextOverlayHeader()` Gets overlay header text.
`List<ManufacturerUI>`	`getManufacturers()`
`List<ManufacturerUI>`	`getManufacturersToExport()` Returns the manufacturers to be exported, which are the currently filtered and selected manufacturers, or all filtered manufacturers if none selected.
`int`	`getNumberOfColumns()`
`static int`	`getNumberOfEntitiesPerPage()`
`String`	`getNumberOfFilteredItems()`
`String`	`getRequestedManufacturerName()`
`int`	`getRowNumber()` Returns row number, if applicable, for first entry in page that contains selected entry (in list of all entries).
`int`	`getRows()` Returns (current) number of rows/entries per page in pagination component.
`ManufacturerUI`	`getSelectedManufacturer()`
`List<ManufacturerUI>`	`getSelectedManufacturers()`
`QueryUI`	`getSelectedQuery()`
`SimpleTableExporter`	`getSimpleTableExporter()`
`void`	`init()` Initializes the bean for initial view display, and invokes service availability check at first invocation.
`boolean`	`isColumnVisible(int columnIndex)` Returns column visibility for column with given index.
`boolean`	`isDeleteButtonEnabled()`
`boolean`	`isEditButtonEnabled()`
`void`	`isManufacturerNameValid(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Checks if there is any other manufacturer apart from selected one, that already has given name.
`boolean`	`isManufacturerRequested()`
`boolean`	`isSingleManufacturerSelected()`
`void`	`onManufacturerAdd()` Event triggered when manufacturer is created.
`void`	`onManufacturerDelete()` Event triggered when manufacturer is deleted.
`void`	`onManufacturerEdit()` Event triggered when manufacturer is updated.
`void`	`onPaginate()` Event triggered when paging for data table.
`void`	`onPaginatePageSize()` Event triggered when paging for data table is complete.
`void`	`onRowSelect()` Event triggered when row is selected in table in UI.
`void`	`onToggle(org.primefaces.event.ToggleEvent event)` Event triggered when toggling column visibility.
`void`	`prepareAddPopup()` Prepare for Add manufacturer dialog.
`void`	`prepareEditPopup()` Prepare for Edit manufacturer dialog.
`void`	`resetDisplayView()` Resets displayView to default
`void`	`resetQuery()` Reset query and refresh manufacturers.
`void`	`resetValues()` Reset values.
`void`	`setFilteredManufacturers(List<ManufacturerUI> filteredManufacturers)`
`void`	`setLongTextOverlayContent(String longTextOverlayContent)` Sets overlay content text.
`void`	`setLongTextOverlayHeader(String longTextOverlayHeader)` Sets overlay header text.
`void`	`setRequestedManufacturerName(String requestedManufacturerName)`
`void`	`setRows(int rows)` Sets (current) number of rows/entries per page in pagination component.
`void`	`setSelectedManufacturers(List<ManufacturerUI> selectedManufacturers)`
`void`	`setSelectedQuery(QueryUI selectedQuery)`
`String`	`tooltipForManufacturer(ManufacturerColumnUI column)` Return tooltip for manufacturer column.
`void`	`unselectAllRows()` Unselect all rows and proceed accordingly, i.e.
`void`	`updateColumns()` Updates columns according to column template and loads data in them.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ManufacturerRequestManager
```
public ManufacturerRequestManager()
```
    Constructs the controller bean and handles one time setup.
- Method Detail
  - init
```
@PostConstruct
public void init()
```
    Initializes the bean for initial view display, and invokes service availability check at first invocation.
  - getRequestedManufacturerName
```
public String getRequestedManufacturerName()
```
  - setRequestedManufacturerName
```
public void setRequestedManufacturerName(String requestedManufacturerName)
```
  - getManufacturers
```
public List<ManufacturerUI> getManufacturers()
```
    Returns:
    
    the manufacturers to be displayed
  - getFilteredManufacturers
```
public List<ManufacturerUI> getFilteredManufacturers()
```
    Returns:
    
    the filtered manufacturers to be displayed
  - setFilteredManufacturers
```
public void setFilteredManufacturers(List<ManufacturerUI> filteredManufacturers)
```
    Parameters:
    
    filteredManufacturers - the filtered manufacturers to set
  - getSelectedManufacturers
```
public List<ManufacturerUI> getSelectedManufacturers()
```
    Returns:
    
    the currently selected manufacturers, cannot return null
  - setSelectedManufacturers
```
public void setSelectedManufacturers(List<ManufacturerUI> selectedManufacturers)
```
    Parameters:
    
    selectedManufacturers - the manufacturers to select
  - clearSelectedManufacturers
```
public void clearSelectedManufacturers()
```
    Clears the current manufacturer selection.
  - getManufacturersToExport
```
public List<ManufacturerUI> getManufacturersToExport()
```
    Returns the manufacturers to be exported, which are the currently filtered and selected manufacturers, or all filtered manufacturers if none selected.
    
    Returns:
    
    the manufacturer to be exported
  - getSimpleTableExporter
```
public SimpleTableExporter getSimpleTableExporter()
```
    Specified by:
    
    getSimpleTableExporter in interface SimpleTableExporterFactory
    
    Returns:
    
    the actual implementation of the simple table exporter for the data type managed by the bean
  - getDateFormatString
```
public String getDateFormatString()
```
    Returns:
    
    the date format string to use to display dates
  - onPaginate
```
public void onPaginate()
```
    Event triggered when paging for data table.
  - onPaginatePageSize
```
public void onPaginatePageSize()
```
    Event triggered when paging for data table is complete. Allows keeping track of pagination page size.
  - onToggle
```
public void onToggle(org.primefaces.event.ToggleEvent event)
```
    Event triggered when toggling column visibility. Allows keeping track of column visibility.
    
    Parameters:
    
    event - toggle event
  - isColumnVisible
```
public boolean isColumnVisible(int columnIndex)
```
    Returns column visibility for column with given index.
    
    Parameters:
    
    columnIndex - column index for column in UI, counting from left
    
    Returns:
    
    true if column is marked as visible
  - unselectAllRows
```
public void unselectAllRows()
```
    Unselect all rows and proceed accordingly, i.e. clear selected manufacturers and row selection.
  - onRowSelect
```
public void onRowSelect()
```
    Event triggered when row is selected in table in UI.
  - isSingleManufacturerSelected
```
public boolean isSingleManufacturerSelected()
```
    Returns:
    
    true if a single manufacturer is selected, false otherwise
  - getIsAddPopupOpened
```
public boolean getIsAddPopupOpened()
```
    Returns:
    
    true if add popup is opened otherwise false.
  - prepareAddPopup
```
public void prepareAddPopup()
```
    Prepare for Add manufacturer dialog.
  - onManufacturerAdd
```
public void onManufacturerAdd()
```
    Event triggered when manufacturer is created.
  - prepareEditPopup
```
public void prepareEditPopup()
```
    Prepare for Edit manufacturer dialog.
  - onManufacturerEdit
```
public void onManufacturerEdit()
```
    Event triggered when manufacturer is updated.
  - getDeletedManufacturers
```
public List<ManufacturerUI> getDeletedManufacturers()
```
    Returns:
    
    the list of deleted manufacturers.
  - resetValues
```
public void resetValues()
```
    Reset values. May be used at e.g. close of delete dialog.
  - checkManufacturersForDeletion
```
public void checkManufacturersForDeletion()
```
    The method builds a list of manufacturers that are already deleted. If the list is not empty, it is displayed to the user and the user is prevented from deleting them.
  - onManufacturerDelete
```
public void onManufacturerDelete()
```
    Event triggered when manufacturer is deleted.
  - getSelectedManufacturer
```
public ManufacturerUI getSelectedManufacturer()
```
    Returns:
    
    the selected manufacturer.
  - getEditManufacturer
```
public boolean getEditManufacturer()
```
    Returns:
    
    true if the current user can edit manufacturers, else false
  - isEditButtonEnabled
```
public boolean isEditButtonEnabled()
```
  - isDeleteButtonEnabled
```
public boolean isDeleteButtonEnabled()
```
  - getSelectedQuery
```
public QueryUI getSelectedQuery()
```
  - setSelectedQuery
```
public void setSelectedQuery(QueryUI selectedQuery)
```
  - executeQuery
```
public void executeQuery(javax.faces.event.ActionEvent e)
```
    Execute selected query.
    
    Parameters:
    
    e - action event
  - excuteQueryId
```
public void excuteQueryId(long id)
```
    Execute query with given id.
    
    Parameters:
    
    id - query id
  - resetQuery
```
public void resetQuery()
```
    Reset query and refresh manufacturers.
  - getNumberOfFilteredItems
```
public String getNumberOfFilteredItems()
```
  - isManufacturerRequested
```
public boolean isManufacturerRequested()
```
  - resetDisplayView
```
public void resetDisplayView()
```
    Resets displayView to default
  - getColumns
```
public List<ManufacturerColumnUI> getColumns()
```
    Returns current columns to show in manufacturer data table
    
    Returns:
    
    columns
  - updateColumns
```
public void updateColumns()
```
    Updates columns according to column template and loads data in them.
  - getNumberOfColumns
```
public int getNumberOfColumns()
```
    Returns:
    
    number of column in current display view.
  - isManufacturerNameValid
```
public void isManufacturerNameValid(javax.faces.context.FacesContext ctx,
                                    javax.faces.component.UIComponent component,
                                    Object value)
```
    Checks if there is any other manufacturer apart from selected one, that already has given name.
    
    Parameters:
    
    ctx - ctx
    
    component - component
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if manufacturer name is not unique
  - setLongTextOverlayHeader
```
public void setLongTextOverlayHeader(String longTextOverlayHeader)
```
    Sets overlay header text.
    
    Parameters:
    
    longTextOverlayHeader - the overlay header text.
  - getLongTextOverlayHeader
```
public String getLongTextOverlayHeader()
```
    Gets overlay header text.
    
    Returns:
    
    the overlay header text.
  - setLongTextOverlayContent
```
public void setLongTextOverlayContent(String longTextOverlayContent)
```
    Sets overlay content text.
    
    Parameters:
    
    longTextOverlayContent - the overlay content text.
  - getLongTextOverlayContent
```
public String getLongTextOverlayContent()
```
    Gets overlay content text.
    
    Returns:
    
    the overlay content text.
  - clearSelection
```
public void clearSelection()
```
    Clears the newly created selected manufacturer so editing is disabled
  - getNumberOfEntitiesPerPage
```
public static int getNumberOfEntitiesPerPage()
```
  - getRowNumber
```
public int getRowNumber()
```
    Returns row number, if applicable, for first entry in page that contains selected entry (in list of all entries). Note. Consider number of entries per page for pagination.
    
    Returns:
    
    row number, if applicable, for first entry in page that contains selected entry
  - getRows
```
public int getRows()
```
    Returns (current) number of rows/entries per page in pagination component.
    
    Returns:
    
    number of rows per page
  - setRows
```
public void setRows(int rows)
```
    Sets (current) number of rows/entries per page in pagination component.
    
    Parameters:
    
    rows - number of rows per page
  - completeFilter
```
public List<String> completeFilter(String query)
```
    Provide suggestions for manufacturer given query to filter for.
    
    Parameters:
    
    query - query to filter for
    
    Returns:
    
    suggestions for manufacturer given query to filter for.
  - tooltipForManufacturer
```
public String tooltipForManufacturer(ManufacturerColumnUI column)
```
    Return tooltip for manufacturer column.
    
    Parameters:
    
    column - manufacturer column
    
    Returns:
    
    tooltip for manufacturer column

Class ManufacturerRequestManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ManufacturerRequestManager

Method Detail

init

getRequestedManufacturerName

setRequestedManufacturerName

getManufacturers

getFilteredManufacturers

setFilteredManufacturers

getSelectedManufacturers

setSelectedManufacturers

clearSelectedManufacturers

getManufacturersToExport

getSimpleTableExporter

getDateFormatString

onPaginate

onPaginatePageSize

onToggle

isColumnVisible

unselectAllRows

onRowSelect

isSingleManufacturerSelected

getIsAddPopupOpened

prepareAddPopup

onManufacturerAdd

prepareEditPopup

onManufacturerEdit

getDeletedManufacturers

resetValues

checkManufacturersForDeletion

onManufacturerDelete

getSelectedManufacturer

getEditManufacturer

isEditButtonEnabled

isDeleteButtonEnabled

getSelectedQuery

setSelectedQuery

executeQuery

excuteQueryId

resetQuery

getNumberOfFilteredItems

isManufacturerRequested

resetDisplayView

getColumns

updateColumns

getNumberOfColumns

isManufacturerNameValid

setLongTextOverlayHeader

getLongTextOverlayHeader

setLongTextOverlayContent

getLongTextOverlayContent

clearSelection

getNumberOfEntitiesPerPage

getRowNumber

getRows

setRows

completeFilter

tooltipForManufacturer