InstallationPackageRequestManager (Cable Database 5.4.1 API)

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

All Implemented Interfaces:

Serializable
```
public class InstallationPackageRequestManager
extends Object
implements Serializable
```
This is the backing requests bean for installation-packages.xhtml.

Author:

Sunil Sah

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`InstallationPackageRequestManager()` 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
`boolean`	`canImportInstallationPackages()`
`void`	`checkInstallationPackagesForDeletion()` The method builds a list of installation packages that are already deleted.
`void`	`clearImportState()` Clears the import state.
`void`	`clearSelectedInstallationPackages()` Clears the current installation package selection.
`void`	`clearSelection()` Clears the newly created selected installation package so editing is disabled
`List<String>`	`completeFilter(String query)` Provide suggestions for installation package given query to filter for.
`List<String>`	`completeUsers(String query, InstallationPackageColumnUI column)` Autocomplete method for users for InstallationPackageColumnUI column.
`List<String>`	`completeUsersCableCoordinator(String query)` Autocomplete method for users for cable coordinator.
`List<String>`	`completeUsersInstallationPackageLeader(String query)` Autocomplete method for users for installation package leader.
`void`	`filterInstallationPackages()` Refreshes installation packages list based on filters.
`List<InstallationPackageColumnUI>`	`getColumns()` Returns current columns to show in installation package data table
`List<InstallationPackageUI>`	`getDeletedInstallationPackages()`
`String`	`getDisplayComments()`
`String`	`getDisplayDescription()`
`String`	`getDisplayService()`
`boolean`	`getEditInstallationPackage()`
`boolean`	`getFileToBeImportedExists()`
`List<InstallationPackageUI>`	`getFilteredInstallationPackages()`
`String`	`getGlobalFilter()`
`LoaderResult<InstallationPackage>`	`getImportResult()`
`org.primefaces.model.StreamedContent`	`getImportTemplate()`
`List<InstallationPackageUI>`	`getInstallationPackages()`
`org.primefaces.model.StreamedContent`	`getInstallationPackageSheetWithImportedInstallationPackages()`
`org.primefaces.model.StreamedContent`	`getInstallationPackageSheetWithInstallationPackagesToExport()`
`List<InstallationPackageUI>`	`getInstallationPackagesToExport()` Returns the installation packages to be exported, which are the currently filtered and selected installation packages, or all filtered cables without deleted ones if none selected.
`int`	`getInstallationPackagesToExportSize()` Return counter for number of installation packages to be exported.
`String[]`	`getInstallers()`
`boolean`	`getIsAddPopupOpened()`
`String`	`getLongOverlayURL()`
`String`	`getLongTextOverlayContent()` Gets overlay content text.
`String`	`getLongTextOverlayHeader()` Gets overlay header text.
`int`	`getNumberOfColumns()`
`static int`	`getNumberOfEntitiesPerPage()`
`String`	`getRequestedInstallationPackageName()`
`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.
`InstallationPackageUI`	`getSelectedInstallationPackage()`
`List<InstallationPackageUI>`	`getSelectedInstallationPackages()`
`void`	`handleDisplayComments()` Formats comments string.
`void`	`handleDisplayDescription()` Formats description string.
`void`	`handleDisplayService()` Formats service string.
`void`	`init()` Initializes the bean for initial view display.
`void`	`installationPackageFileUpload(org.primefaces.event.FileUploadEvent event)` Uploads and stores the file.
`void`	`installationPackageImport()` Performs the installation package import from the file that was last uploaded.
`void`	`installationPackageImportTest()` Performs a test of the installation package import from the file that was last uploaded.
`boolean`	`isColumnVisible(InstallationPackageColumnUI column)` Returns column visibility for given column.
`boolean`	`isColumnVisible(int columnIndex)` Returns column visibility for column with given index.
`boolean`	`isDeleteButtonEnabled()`
`boolean`	`isEditButtonEnabled()`
`void`	`isFloatEntered(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is Float number.
`void`	`isInstallationPackageNameValid(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validate installation package name.
`boolean`	`isInstallationPackageRequested()`
`void`	`isIntegerEntered(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is Integer number.
`void`	`isURLEntered(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is URL.
`void`	`onInstallationPackageAdd()` Event triggered when installation package is created.
`void`	`onInstallationPackageDelete()` Event triggered when installation package is deleted.
`void`	`onInstallationPackageEdit()` Event triggered when installation package 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 installation package dialog.
`void`	`prepareEditPopup()` Prepare for Edit installation package dialog.
`void`	`resetDisplayView()` Resets displayView to default.
`void`	`resetValues()` Reset values.
`void`	`setDisplayComments(String displayComments)` Sets comments string.
`void`	`setDisplayDescription(String displayDescription)` Sets description string.
`void`	`setDisplayService(String displayService)` Sets service string.
`void`	`setFilteredInstallationPackages(List<InstallationPackageUI> filteredInstallationPackages)`
`void`	`setGlobalFilter(String globalFilter)`
`void`	`setLongOverlayURL(String longOverlayURL)` Sets the URL for the long general popup.
`void`	`setLongTextOverlayContent(String longTextOverlayContent)` Sets overlay content text.
`void`	`setLongTextOverlayHeader(String longTextOverlayHeader)` Sets overlay header text.
`void`	`setRequestedInstallationPackageName(String requestedInstallationPackageName)`
`void`	`setRows(int rows)` Sets (current) number of rows/entries per page in pagination component.
`void`	`setSelectedInstallationPackages(List<InstallationPackageUI> selectedInstallationPackages)`
`String`	`tooltipForInstallationPackage(InstallationPackageColumnUI column)` Return tooltip for installation package column.
`String`	`tooltipForLink(String label, String column, String value)` Return tooltip for installation package link.
`void`	`unselectAllRows()` Unselect all rows and proceed accordingly, i.e.
`void`	`updateColumns()` Updates columns according to column template and loads data in them.
`void`	`updateInstallationPackagesToExportSize()` Update counter for number of installation packages to be exported.

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

- Constructor Detail
  - InstallationPackageRequestManager
```
public InstallationPackageRequestManager()
```
    Constructs the controller bean and handles one time setup.
- Method Detail
  - init
```
@PostConstruct
public void init()
```
    Initializes the bean for initial view display.
  - getFileToBeImportedExists
```
public boolean getFileToBeImportedExists()
```
    Returns:
    
    true if the uploaded file that hasn't been imported yet exists, false otherwise
  - getInstallationPackagesToExport
```
public List<InstallationPackageUI> getInstallationPackagesToExport()
```
    Returns the installation packages to be exported, which are the currently filtered and selected installation packages, or all filtered cables without deleted ones if none selected.
    
    Returns:
    
    the installation packages to be exported
  - getImportResult
```
public LoaderResult<InstallationPackage> getImportResult()
```
    Returns:
    
    the result of a test or true import
  - clearImportState
```
public void clearImportState()
```
    Clears the import state.
  - installationPackageFileUpload
```
public void installationPackageFileUpload(org.primefaces.event.FileUploadEvent event)
```
    Uploads and stores the file.
    
    Parameters:
    
    event - the event containing the file
  - installationPackageImportTest
```
public void installationPackageImportTest()
```
    Performs a test of the installation package import from the file that was last uploaded.
  - installationPackageImport
```
public void installationPackageImport()
```
    Performs the installation package import from the file that was last uploaded.
  - getInstallationPackageSheetWithImportedInstallationPackages
```
public org.primefaces.model.StreamedContent getInstallationPackageSheetWithImportedInstallationPackages()
```
    Returns:
    
    the installation package sheet with installation packages that were just imported
  - getInstallationPackageSheetWithInstallationPackagesToExport
```
public org.primefaces.model.StreamedContent getInstallationPackageSheetWithInstallationPackagesToExport()
```
    Returns:
    
    the installation package sheet with the installation packages from installationPackagesToExport list
  - getImportTemplate
```
public org.primefaces.model.StreamedContent getImportTemplate()
```
    Returns:
    
    the installation package import template
  - isEditButtonEnabled
```
public boolean isEditButtonEnabled()
```
    Returns:
    
    true if edit installation package button is enabled, otherwise false.
  - isDeleteButtonEnabled
```
public boolean isDeleteButtonEnabled()
```
    Returns:
    
    true if delete installation package button is enabled, otherwise false.
  - getRequestedInstallationPackageName
```
public String getRequestedInstallationPackageName()
```
  - setRequestedInstallationPackageName
```
public void setRequestedInstallationPackageName(String requestedInstallationPackageName)
```
  - isInstallationPackageRequested
```
public boolean isInstallationPackageRequested()
```
  - getInstallationPackages
```
public List<InstallationPackageUI> getInstallationPackages()
```
    Returns:
    
    the installation packages to be displayed
  - getFilteredInstallationPackages
```
public List<InstallationPackageUI> getFilteredInstallationPackages()
```
    Returns:
    
    the filtered installation packages to be displayed
  - setFilteredInstallationPackages
```
public void setFilteredInstallationPackages(List<InstallationPackageUI> filteredInstallationPackages)
```
    Parameters:
    
    filteredInstallationPackages - the filtered installation packages to set
  - getGlobalFilter
```
public String getGlobalFilter()
```
    Returns:
    
    the global text filter
  - setGlobalFilter
```
public void setGlobalFilter(String globalFilter)
```
    Parameters:
    
    globalFilter - the global text filter to set
  - filterInstallationPackages
```
public void filterInstallationPackages()
```
    Refreshes installation packages list based on filters.
  - getSelectedInstallationPackages
```
public List<InstallationPackageUI> getSelectedInstallationPackages()
```
    Returns:
    
    the currently selected installation packages, cannot return null
  - setSelectedInstallationPackages
```
public void setSelectedInstallationPackages(List<InstallationPackageUI> selectedInstallationPackages)
```
    Parameters:
    
    selectedInstallationPackages - the installation packages to select
  - clearSelectedInstallationPackages
```
public void clearSelectedInstallationPackages()
```
    Clears the current installation package selection.
  - 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
  - isColumnVisible
```
public boolean isColumnVisible(InstallationPackageColumnUI column)
```
    Returns column visibility for given column.
    
    Parameters:
    
    column - given column
    
    Returns:
    
    column visibility
  - unselectAllRows
```
public void unselectAllRows()
```
    Unselect all rows and proceed accordingly, i.e. clear selected installation packages and row selection.
  - onRowSelect
```
public void onRowSelect()
```
    Event triggered when row is selected in table in UI.
  - getIsAddPopupOpened
```
public boolean getIsAddPopupOpened()
```
    Returns:
    
    true if add popup is opened otherwise false.
  - prepareAddPopup
```
public void prepareAddPopup()
```
    Prepare for Add installation package dialog.
  - resetValues
```
public void resetValues()
```
    Reset values. May be used at e.g. close of delete dialog.
  - onInstallationPackageAdd
```
public void onInstallationPackageAdd()
```
    Event triggered when installation package is created.
  - prepareEditPopup
```
public void prepareEditPopup()
```
    Prepare for Edit installation package dialog.
  - onInstallationPackageEdit
```
public void onInstallationPackageEdit()
```
    Event triggered when installation package is updated.
  - getDeletedInstallationPackages
```
public List<InstallationPackageUI> getDeletedInstallationPackages()
```
    Returns:
    
    the list of deleted installation packages.
  - checkInstallationPackagesForDeletion
```
public void checkInstallationPackagesForDeletion()
```
    The method builds a list of installation packages that are already deleted. If the list is not empty, it is displayed to the user and the user is prevented from deleting them.
  - onInstallationPackageDelete
```
public void onInstallationPackageDelete()
```
    Event triggered when installation package is deleted.
  - isInstallationPackageNameValid
```
public void isInstallationPackageNameValid(javax.faces.context.FacesContext ctx,
                                           javax.faces.component.UIComponent component,
                                           Object value)
```
    Validate installation package name. Throws ValidatorException if installation package with given name already exists.
    
    Parameters:
    
    ctx - faces context
    
    component - ui component
    
    value - installation package name
  - isIntegerEntered
```
public void isIntegerEntered(javax.faces.context.FacesContext ctx,
                             javax.faces.component.UIComponent component,
                             Object value)
```
    Validates if entered value is Integer number.
    
    Parameters:
    
    ctx - faces context
    
    component - component
    
    value - entered value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if entered value is not Integer number
  - isFloatEntered
```
public void isFloatEntered(javax.faces.context.FacesContext ctx,
                           javax.faces.component.UIComponent component,
                           Object value)
```
    Validates if entered value is Float number.
    
    Parameters:
    
    ctx - faces context
    
    component - component
    
    value - entered value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if entered value is not Double number
  - isURLEntered
```
public void isURLEntered(javax.faces.context.FacesContext ctx,
                         javax.faces.component.UIComponent component,
                         Object value)
```
    Validates if entered value is URL.
    
    Parameters:
    
    ctx - faces context
    
    component - component
    
    value - entered value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if entered value is not URL
  - getSelectedInstallationPackage
```
public InstallationPackageUI getSelectedInstallationPackage()
```
    Returns:
    
    the selected installation package
  - getEditInstallationPackage
```
public boolean getEditInstallationPackage()
```
    Returns:
    
    true if the current user can edit installation package, else false
  - getDisplayDescription
```
public String getDisplayDescription()
```
    Returns:
    
    description string for display.
  - setDisplayDescription
```
public void setDisplayDescription(String displayDescription)
```
    Sets description string.
    
    Parameters:
    
    displayDescription - string
  - handleDisplayDescription
```
public void handleDisplayDescription()
```
    Formats description string.
  - getDisplayService
```
public String getDisplayService()
```
    Returns:
    
    service string for display.
  - setDisplayService
```
public void setDisplayService(String displayService)
```
    Sets service string.
    
    Parameters:
    
    displayService - service string
  - handleDisplayService
```
public void handleDisplayService()
```
    Formats service string.
  - getDisplayComments
```
public String getDisplayComments()
```
    Returns:
    
    comments string for display.
  - setDisplayComments
```
public void setDisplayComments(String displayComments)
```
    Sets comments string.
    
    Parameters:
    
    displayComments - comments string.
  - handleDisplayComments
```
public void handleDisplayComments()
```
    Formats comments string.
  - resetDisplayView
```
public void resetDisplayView()
```
    Resets displayView to default.
  - getColumns
```
public List<InstallationPackageColumnUI> getColumns()
```
    Returns current columns to show in installation package 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
  - getInstallationPackagesToExportSize
```
public int getInstallationPackagesToExportSize()
```
    Return counter for number of installation packages to be exported.
    
    Returns:
    
    number of installation packages to be exported
  - updateInstallationPackagesToExportSize
```
public void updateInstallationPackagesToExportSize()
```
    Update counter for number of installation packages to be exported.
  - canImportInstallationPackages
```
public boolean canImportInstallationPackages()
```
    Returns:
    
    true if the current user can import installation packages, else false
  - 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.
  - setLongOverlayURL
```
public void setLongOverlayURL(String longOverlayURL)
```
    Sets the URL for the long general popup.
    
    Parameters:
    
    longOverlayURL - the url to where the popup is pointing.
  - getLongOverlayURL
```
public String getLongOverlayURL()
```
    Returns:
    
    URL for the long general popup.
  - clearSelection
```
public void clearSelection()
```
    Clears the newly created selected installation package 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 installation package given query to filter for.
    
    Parameters:
    
    query - query to filter for
    
    Returns:
    
    suggestions for installation package given query to filter for.
  - tooltipForInstallationPackage
```
public String tooltipForInstallationPackage(InstallationPackageColumnUI column)
```
    Return tooltip for installation package column.
    
    Parameters:
    
    column - installation package column
    
    Returns:
    
    tooltip for installation package column
  - tooltipForLink
```
public String tooltipForLink(String label,
                             String column,
                             String value)
```
    Return tooltip for installation package link.
    
    Parameters:
    
    label - label
    
    column - column
    
    value - (part of) tooltip
    
    Returns:
    
    tooltip for installation package link
  - getInstallers
```
public String[] getInstallers()
```
    Returns:
    
    available installers.
  - completeUsersCableCoordinator
```
public List<String> completeUsersCableCoordinator(String query)
```
    Autocomplete method for users for cable coordinator.
    
    Parameters:
    
    query - query to filter users
    
    Returns:
    
    users
  - completeUsersInstallationPackageLeader
```
public List<String> completeUsersInstallationPackageLeader(String query)
```
    Autocomplete method for users for installation package leader.
    
    Parameters:
    
    query - query to filter users
    
    Returns:
    
    users
  - completeUsers
```
public List<String> completeUsers(String query,
                                  InstallationPackageColumnUI column)
```
    Autocomplete method for users for InstallationPackageColumnUI column.
    
    Parameters:
    
    query - query to filter users
    
    column - intended column (InstallationPackageColumnUI)
    
    Returns:
    
    users

Class InstallationPackageRequestManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstallationPackageRequestManager

Method Detail

init

getFileToBeImportedExists

getInstallationPackagesToExport

getImportResult

clearImportState

installationPackageFileUpload

installationPackageImportTest

installationPackageImport

getInstallationPackageSheetWithImportedInstallationPackages

getInstallationPackageSheetWithInstallationPackagesToExport

getImportTemplate

isEditButtonEnabled

isDeleteButtonEnabled

getRequestedInstallationPackageName

setRequestedInstallationPackageName

isInstallationPackageRequested

getInstallationPackages

getFilteredInstallationPackages

setFilteredInstallationPackages

getGlobalFilter

setGlobalFilter

filterInstallationPackages

getSelectedInstallationPackages

setSelectedInstallationPackages

clearSelectedInstallationPackages

onPaginate

onPaginatePageSize

onToggle

isColumnVisible

isColumnVisible

unselectAllRows

onRowSelect

getIsAddPopupOpened

prepareAddPopup

resetValues

onInstallationPackageAdd

prepareEditPopup

onInstallationPackageEdit

getDeletedInstallationPackages

checkInstallationPackagesForDeletion

onInstallationPackageDelete

isInstallationPackageNameValid

isIntegerEntered

isFloatEntered

isURLEntered

getSelectedInstallationPackage

getEditInstallationPackage

getDisplayDescription

setDisplayDescription

handleDisplayDescription

getDisplayService

setDisplayService

handleDisplayService

getDisplayComments

setDisplayComments

handleDisplayComments

resetDisplayView

getColumns

updateColumns

getNumberOfColumns

getInstallationPackagesToExportSize

updateInstallationPackagesToExportSize

canImportInstallationPackages

setLongTextOverlayHeader

getLongTextOverlayHeader

setLongTextOverlayContent

getLongTextOverlayContent

setLongOverlayURL

getLongOverlayURL

clearSelection

getNumberOfEntitiesPerPage

getRowNumber

getRows