ConnectorRequestManager (Cable Database 5.4.1 API)

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

All Implemented Interfaces:

Serializable
```
public class ConnectorRequestManager
extends Object
implements Serializable
```
This is the backing requests bean for connectors.xhtml.

Author:

Sunil Sah

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`ConnectorRequestManager()` 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`	`addManufacturer()` Add column to currently selected displayView
`Boolean`	`canImportConnectors()`
`void`	`checkConnectorsForDeletion()` The method builds a list of connectors that are already deleted.
`void`	`clearImportState()` Clears the import state.
`void`	`clearSelectedConnectors()` Clears the current connector selection.
`void`	`clearSelection()` Clears the newly created selected connector so editing is disabled
`List<Manufacturer>`	`completeAvailableManufacturers(String query)` Autocomplete method for manufacturers
`List<String>`	`completeFilter(String query)` Provide suggestions for connector given query to filter for.
`void`	`connectorFileUpload(org.primefaces.event.FileUploadEvent event)` Uploads and stores the file.
`void`	`connectorImport()` Performs the connector import from the file that was last uploaded.
`void`	`connectorImportTest()` Performs a test of the connector import from the file that was last uploaded.
`void`	`excuteQueryId(long id)` Execute query with given id.
`void`	`executeQuery(javax.faces.event.ActionEvent e)` Execute selected query.
`List<Manufacturer>`	`getAvailableManufacturers()`
`boolean`	`getChangeManufacturersPermission()`
`List<ConnectorColumnUI>`	`getColumns()` Returns current columns to show in connector data table
`List<ConnectorUI>`	`getConnectors()`
`org.primefaces.model.StreamedContent`	`getConnectorsToExport()`
`List<Connector>`	`getConnectorsToExportList()`
`String`	`getDateFormatString()`
`List<ConnectorUI>`	`getDeletedConnectors()`
`boolean`	`getEditConnector()`
`byte[]`	`getFileToBeImported()`
`boolean`	`getFileToBeImportedExists()`
`List<ConnectorUI>`	`getFilteredConnectors()`
`String`	`getImportFileName()`
`LoaderResult<Connector>`	`getImportResult()`
`org.primefaces.model.StreamedContent`	`getImportTemplate()`
`boolean`	`getIsAddPopupOpened()`
`List<ConnectorManufacturer>`	`getLongManufacturersListOverlay()`
`String`	`getLongOverlayURL()`
`String`	`getLongTextOverlayContent()` Gets overlay content text.
`String`	`getLongTextOverlayHeader()` Gets overlay header text.
`int`	`getNumberOfColumns()`
`static int`	`getNumberOfEntitiesPerPage()`
`String`	`getNumberOfFilteredItems()`
`String`	`getRequestedConnectorName()`
`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.
`ConnectorUI`	`getSelectedConnector()`
`List<ConnectorUI>`	`getSelectedConnectors()`
`ConnectorManufacturer`	`getSelectedManufacturer()`
`List<ConnectorManufacturer>`	`getSelectedManufacturers()`
`QueryUI`	`getSelectedQuery()`
`void`	`handleDatasheetUpload(org.primefaces.event.FileUploadEvent event)` Import and upload datasheet for selected connector.
`void`	`handleManufacturerDatasheetUpload(org.primefaces.event.FileUploadEvent event)` Import and upload datasheet for selected manufacturer.
`boolean`	`hasDatasheet()` Return if selected connector has an associated datasheet.
`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.
`void`	`isConnectorNameValid(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Checks if there is any other connector apart from selected one, that already has given name.
`boolean`	`isConnectorRequested()`
`boolean`	`isDeleteButtonEnabled()`
`boolean`	`isEditButtonEnabled()`
`boolean`	`isSingleConnectorSelected()`
`void`	`moveManufacturerDown()` Swap position of current manufacturer and the one before it.
`void`	`moveManufacturerUp()` Swap position of current manufacturer and the one before it.
`void`	`onConnectorAdd()` Event triggered when connector is created.
`void`	`onConnectorDelete()` Event triggered when connector is deleted.
`void`	`onConnectorEdit()` Event triggered when connector 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 connector dialog.
`void`	`prepareEditPopup()` Prepare for Edit connector dialog.
`void`	`removeDatasheet()` Remove datasheet for selected connector
`void`	`removeManufacturer()` Remove currently selected displayViewColumn
`void`	`removeManufacturerDatasheet()` Remove datasheet for selected manufacturer.
`void`	`resetDisplayView()` Resets displayView to default
`void`	`resetQuery()` Reset query and refresh connectors.
`void`	`resetValues()` Reset values.
`boolean`	`selectedManufacturerHasDatasheet()` Return if selected manufacturer has an associated datasheet.
`void`	`setAvailableManufacturers(List<Manufacturer> availableManufacturers)`
`void`	`setFileToBeImported(byte[] fileToBeImported)`
`void`	`setFilteredConnectors(List<ConnectorUI> filteredConnectors)`
`void`	`setImportFileName(String importFileName)`
`void`	`setImportResult(LoaderResult<Connector> importResult)`
`void`	`setLongManufacturersOverlayConnector(ConnectorUI longManufacturersOverlayConnector)` Sets the cableType for the long manufacturers popup.
`void`	`setLongOverlayURL(String longOverlayURL)`
`void`	`setLongTextOverlayContent(String longTextOverlayContent)` Sets overlay content text.
`void`	`setLongTextOverlayHeader(String longTextOverlayHeader)` Sets overlay header text.
`void`	`setRequestedConnectorName(String requestedConnectorName)`
`void`	`setRows(int rows)` Sets (current) number of rows/entries per page in pagination component.
`void`	`setSelectedConnectors(List<ConnectorUI> selectedConnectors)`
`void`	`setSelectedManufacturer(ConnectorManufacturer selectedManufacturer)`
`void`	`setSelectedQuery(QueryUI selectedQuery)`
`String`	`tooltipForConnector(ConnectorColumnUI column, String value)` Return tooltip for connector.
`void`	`unselectAllRows()` Unselect all rows and proceed accordingly, i.e.
`void`	`updateColumns()` Updates columns according to column template and loads data in them.
`String`	`urlForColumn(ConnectorColumnUI column, ConnectorUI connectorUi)` Return url for column.

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

- Constructor Detail
  - ConnectorRequestManager
```
public ConnectorRequestManager()
```
    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.
  - getLongOverlayURL
```
public String getLongOverlayURL()
```
  - setLongOverlayURL
```
public void setLongOverlayURL(String longOverlayURL)
```
  - getRequestedConnectorName
```
public String getRequestedConnectorName()
```
  - setRequestedConnectorName
```
public void setRequestedConnectorName(String requestedConnectorName)
```
  - getConnectors
```
public List<ConnectorUI> getConnectors()
```
    Returns:
    
    the connectors to be displayed
  - getFilteredConnectors
```
public List<ConnectorUI> getFilteredConnectors()
```
    Returns:
    
    the filtered connectors to be displayed
  - setFilteredConnectors
```
public void setFilteredConnectors(List<ConnectorUI> filteredConnectors)
```
    Parameters:
    
    filteredConnectors - the filtered connectors to set
  - getSelectedConnectors
```
public List<ConnectorUI> getSelectedConnectors()
```
    Returns:
    
    the currently selected connectors, cannot return null
  - setSelectedConnectors
```
public void setSelectedConnectors(List<ConnectorUI> selectedConnectors)
```
    Parameters:
    
    selectedConnectors - the connectors to select
  - clearSelectedConnectors
```
public void clearSelectedConnectors()
```
    Clears the current connector selection.
  - getConnectorsToExport
```
public org.primefaces.model.StreamedContent getConnectorsToExport()
```
    Returns:
    
    the Connector sheet with the cables from connectorsToExport list
  - getConnectorsToExportList
```
public List<Connector> getConnectorsToExportList()
```
  - 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 connectors and row selection.
  - onRowSelect
```
public void onRowSelect()
```
    Event triggered when row is selected in table in UI.
  - isSingleConnectorSelected
```
public boolean isSingleConnectorSelected()
```
    Returns:
    
    true if a single connector is selected, false otherwise
  - getIsAddPopupOpened
```
public boolean getIsAddPopupOpened()
```
    Returns:
    
    true if add popup is opened otherwise false.
  - prepareAddPopup
```
public void prepareAddPopup()
```
    Prepare for Add connector dialog.
  - onConnectorAdd
```
public void onConnectorAdd()
```
    Event triggered when connector is created.
  - prepareEditPopup
```
public void prepareEditPopup()
```
    Prepare for Edit connector dialog.
  - onConnectorEdit
```
public void onConnectorEdit()
```
    Event triggered when connector is updated.
  - getDeletedConnectors
```
public List<ConnectorUI> getDeletedConnectors()
```
    Returns:
    
    the list of deleted connectors.
  - resetValues
```
public void resetValues()
```
    Reset values. May be used at e.g. close of delete dialog.
  - checkConnectorsForDeletion
```
public void checkConnectorsForDeletion()
```
    The method builds a list of connectors that are already deleted. If the list is not empty, it is displayed to the user and the user is prevented from deleting them.
  - onConnectorDelete
```
public void onConnectorDelete()
```
    Event triggered when connector is deleted.
  - handleDatasheetUpload
```
public void handleDatasheetUpload(org.primefaces.event.FileUploadEvent event)
```
    Import and upload datasheet for selected connector.
    
    Parameters:
    
    event - file upload event
  - getSelectedConnector
```
public ConnectorUI getSelectedConnector()
```
    Returns:
    
    the selected connector.
  - getSelectedManufacturers
```
public List<ConnectorManufacturer> getSelectedManufacturers()
```
    Returns:
    
    the selected connector's manufacturers.
  - getEditConnector
```
public boolean getEditConnector()
```
    Returns:
    
    true if the current user can edit connectors, 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 connectors.
  - getNumberOfFilteredItems
```
public String getNumberOfFilteredItems()
```
  - isConnectorRequested
```
public boolean isConnectorRequested()
```
  - resetDisplayView
```
public void resetDisplayView()
```
    Resets displayView to default
  - getColumns
```
public List<ConnectorColumnUI> getColumns()
```
    Returns current columns to show in connector 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.
  - isConnectorNameValid
```
public void isConnectorNameValid(javax.faces.context.FacesContext ctx,
                                 javax.faces.component.UIComponent component,
                                 Object value)
```
    Checks if there is any other connector apart from selected one, that already has given name.
    
    Parameters:
    
    ctx - ctx
    
    component - component
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if connector name is not unique
  - completeFilter
```
public List<String> completeFilter(String query)
```
    Provide suggestions for connector given query to filter for.
    
    Parameters:
    
    query - query to filter for
    
    Returns:
    
    suggestions for connector given query to filter for.
  - completeAvailableManufacturers
```
public List<Manufacturer> completeAvailableManufacturers(String query)
```
    Autocomplete method for manufacturers
    
    Parameters:
    
    query - the query to filter manufacturers
    
    Returns:
    
    all available manufacturers from manufacturer service.
  - getChangeManufacturersPermission
```
public boolean getChangeManufacturersPermission()
```
    Returns:
    
    true if current user is allowed to change cable type manufacturers
  - addManufacturer
```
public void addManufacturer()
```
    Add column to currently selected displayView
  - removeManufacturer
```
public void removeManufacturer()
```
    Remove currently selected displayViewColumn
  - removeManufacturerDatasheet
```
public void removeManufacturerDatasheet()
```
    Remove datasheet for selected manufacturer.
  - removeDatasheet
```
public void removeDatasheet()
```
    Remove datasheet for selected connector
  - moveManufacturerUp
```
public void moveManufacturerUp()
```
    Swap position of current manufacturer and the one before it.
  - moveManufacturerDown
```
public void moveManufacturerDown()
```
    Swap position of current manufacturer and the one before it.
  - handleManufacturerDatasheetUpload
```
public void handleManufacturerDatasheetUpload(org.primefaces.event.FileUploadEvent event)
```
    Import and upload datasheet for selected manufacturer.
    
    Parameters:
    
    event - file upload event
  - 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.
  - setLongManufacturersOverlayConnector
```
public void setLongManufacturersOverlayConnector(ConnectorUI longManufacturersOverlayConnector)
```
    Sets the cableType for the long manufacturers popup.
    
    Parameters:
    
    longManufacturersOverlayConnector - connector.
  - getLongManufacturersListOverlay
```
public List<ConnectorManufacturer> getLongManufacturersListOverlay()
```
    Returns:
    
    list of manufacturers for the long manufacturers popup.
  - clearSelection
```
public void clearSelection()
```
    Clears the newly created selected connector 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
  - getSelectedManufacturer
```
public ConnectorManufacturer getSelectedManufacturer()
```
  - selectedManufacturerHasDatasheet
```
public boolean selectedManufacturerHasDatasheet()
```
    Return if selected manufacturer has an associated datasheet.
    
    Returns:
    
    true if if selected manufacturer has an associated datasheet
  - hasDatasheet
```
public boolean hasDatasheet()
```
    Return if selected connector has an associated datasheet.
    
    Returns:
    
    true if selected connector has an associated datasheet.
  - setSelectedManufacturer
```
public void setSelectedManufacturer(ConnectorManufacturer selectedManufacturer)
```
  - getAvailableManufacturers
```
public List<Manufacturer> getAvailableManufacturers()
```
  - setAvailableManufacturers
```
public void setAvailableManufacturers(List<Manufacturer> availableManufacturers)
```
  - tooltipForConnector
```
public String tooltipForConnector(ConnectorColumnUI column,
                                  String value)
```
    Return tooltip for connector.
    
    Parameters:
    
    column - connector column ui
    
    value - (part of) tooltip
    
    Returns:
    
    tooltip for connector
  - urlForColumn
```
public String urlForColumn(ConnectorColumnUI column,
                           ConnectorUI connectorUi)
```
    Return url for column.
    
    Parameters:
    
    column - connector column ui
    
    connectorUi - connector ui
    
    Returns:
    
    url for column
  - clearImportState
```
public void clearImportState()
```
    Clears the import state.
  - getFileToBeImportedExists
```
public boolean getFileToBeImportedExists()
```
    Returns:
    
    true if the uploaded file that hasn't been imported yet exists, false otherwise
  - getImportTemplate
```
public org.primefaces.model.StreamedContent getImportTemplate()
```
    Returns:
    
    the connector import template
  - canImportConnectors
```
public Boolean canImportConnectors()
```
    Returns:
    
    true if the current user can import connectors, else false
  - getFileToBeImported
```
public byte[] getFileToBeImported()
```
  - setFileToBeImported
```
public void setFileToBeImported(byte[] fileToBeImported)
```
  - getImportResult
```
public LoaderResult<Connector> getImportResult()
```
  - setImportResult
```
public void setImportResult(LoaderResult<Connector> importResult)
```
  - getImportFileName
```
public String getImportFileName()
```
  - setImportFileName
```
public void setImportFileName(String importFileName)
```
  - connectorFileUpload
```
public void connectorFileUpload(org.primefaces.event.FileUploadEvent event)
```
    Uploads and stores the file.
    
    Parameters:
    
    event - the event containing the file
  - connectorImportTest
```
public void connectorImportTest()
```
    Performs a test of the connector import from the file that was last uploaded.
  - connectorImport
```
public void connectorImport()
```
    Performs the connector import from the file that was last uploaded.

Class ConnectorRequestManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectorRequestManager

Method Detail

init

getLongOverlayURL

setLongOverlayURL

getRequestedConnectorName

setRequestedConnectorName

getConnectors

getFilteredConnectors

setFilteredConnectors

getSelectedConnectors

setSelectedConnectors

clearSelectedConnectors

getConnectorsToExport

getConnectorsToExportList

getDateFormatString

onPaginate

onPaginatePageSize

onToggle

isColumnVisible

unselectAllRows

onRowSelect

isSingleConnectorSelected

getIsAddPopupOpened

prepareAddPopup

onConnectorAdd

prepareEditPopup

onConnectorEdit

getDeletedConnectors

resetValues

checkConnectorsForDeletion

onConnectorDelete

handleDatasheetUpload

getSelectedConnector

getSelectedManufacturers

getEditConnector

isEditButtonEnabled

isDeleteButtonEnabled

getSelectedQuery

setSelectedQuery

executeQuery

excuteQueryId

resetQuery

getNumberOfFilteredItems

isConnectorRequested

resetDisplayView

getColumns

updateColumns

getNumberOfColumns

isConnectorNameValid

completeFilter

completeAvailableManufacturers

getChangeManufacturersPermission

addManufacturer

removeManufacturer

removeManufacturerDatasheet

removeDatasheet

moveManufacturerUp

moveManufacturerDown

handleManufacturerDatasheetUpload

setLongTextOverlayHeader

getLongTextOverlayHeader

setLongTextOverlayContent

getLongTextOverlayContent

setLongManufacturersOverlayConnector

getLongManufacturersListOverlay

clearSelection

getNumberOfEntitiesPerPage

getRowNumber

getRows

setRows

getSelectedManufacturer

selectedManufacturerHasDatasheet

hasDatasheet

setSelectedManufacturer