CableArticleRequestManager (Cable Database 5.4.1 API)

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

All Implemented Interfaces:

Serializable
```
public class CableArticleRequestManager
extends Object
implements Serializable
```
This is the backing requests bean for cable-articles.xhtml.

Author:

Lars Johansson

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`CableArticleRequestManager()` 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`	`cableArticleFileUpload(org.primefaces.event.FileUploadEvent event)` Uploads and stores the file.
`void`	`cableArticleImport()` Performs the cable article import from the file that was last uploaded.
`void`	`cableArticleImportTest()` Performs a test of the cable article import from the file that was last uploaded.
`boolean`	`canImportCableArticles()` Return true if the current user can import cable articles, else false.
`void`	`checkCableArticlesForDeletion()` The method builds a list of cable articles that are already deleted.
`void`	`clearImportState()` Clears the import state.
`void`	`clearSelectedCableArticles()` Clears the current cable article selection.
`void`	`clearSelection()` Clears the newly created selected cable article so editing is disabled
`List<String>`	`completeFilter(String query)` Provide suggestions for cable article given query to filter for.
`void`	`filterCableArticles()` Refreshes cable articles list based on filters.
`List<CableArticleUI>`	`getCableArticles()`
`org.primefaces.model.StreamedContent`	`getCableArticleSheetWithCableArticlesToExport()`
`org.primefaces.model.StreamedContent`	`getCableArticleSheetWithImportedCableArticles()`
`List<CableArticleUI>`	`getCableArticlesToExport()` Returns the cable articles to be exported, which are the currently filtered and selected cable articles, or all filtered cables without deleted ones if none selected.
`int`	`getCableArticlesToExportSize()` Return counter for number of cable articles to be exported.
`List<CableArticleColumnUI>`	`getColumns()` Returns current columns to show in cable article data table
`List<CableArticleUI>`	`getDeletedCableArticles()`
`String`	`getDisplayComments()`
`String`	`getDisplayDescription()`
`String`	`getDisplayService()`
`boolean`	`getEditCableArticle()` Return true if the current user can edit cable article, else false.
`boolean`	`getFileToBeImportedExists()`
`List<CableArticleUI>`	`getFilteredCableArticles()`
`String`	`getGlobalFilter()`
`LoaderResult<CableArticle>`	`getImportResult()`
`org.primefaces.model.StreamedContent`	`getImportTemplate()`
`boolean`	`getIsAddPopupOpened()`
`String`	`getLongOverlayURL()`
`String`	`getLongTextOverlayContent()` Gets overlay content text.
`String`	`getLongTextOverlayHeader()` Gets overlay header text.
`int`	`getNumberOfColumns()`
`static int`	`getNumberOfEntitiesPerPage()`
`String`	`getRequestedCableArticleName()`
`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.
`CableArticleUI`	`getSelectedCableArticle()`
`List<CableArticleUI>`	`getSelectedCableArticles()`
`String[]`	`getStandardParts()`
`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`	`isCableArticleErpNumberValid(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validate cable article epr number.
`void`	`isCableArticleExternalIdValid(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validate cable article external id.
`void`	`isCableArticleManufacturerValid(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validate cable article manufacturer.
`boolean`	`isCableArticleRequested()`
`void`	`isCableArticleShortNameExternalIdValid(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validate cable article short name .
`boolean`	`isColumnVisible(CableArticleColumnUI 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`	`onCableArticleAdd()` Event triggered when cable article is created.
`void`	`onCableArticleDelete()` Event triggered when cable article is deleted.
`void`	`onCableArticleEdit()` Event triggered when cable article 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 cable article dialog.
`void`	`prepareEditPopup()` Prepare for Edit cable article 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`	`setFilteredCableArticles(List<CableArticleUI> filteredCableArticles)`
`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`	`setRequestedCableArticleName(String requestedCableArticleName)`
`void`	`setRows(int rows)` Sets (current) number of rows/entries per page in pagination component.
`void`	`setSelectedCableArticles(List<CableArticleUI> selectedCableArticles)`
`String`	`tooltipForCableArticle(CableArticleColumnUI column)` Return tooltip for cable article column.
`String`	`tooltipForLink(String label, String column, String value)` Return tooltip for cable article link.
`void`	`unselectAllRows()` Unselect all rows and proceed accordingly, i.e.
`void`	`updateCableArticlesToExportSize()` Update counter for number of cable articles to be exported.
`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
  - CableArticleRequestManager
```
public CableArticleRequestManager()
```
    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
  - getCableArticlesToExport
```
public List<CableArticleUI> getCableArticlesToExport()
```
    Returns the cable articles to be exported, which are the currently filtered and selected cable articles, or all filtered cables without deleted ones if none selected.
    
    Returns:
    
    the cable articles to be exported
  - getImportResult
```
public LoaderResult<CableArticle> getImportResult()
```
    Returns:
    
    the result of a test or true import
  - clearImportState
```
public void clearImportState()
```
    Clears the import state.
  - cableArticleFileUpload
```
public void cableArticleFileUpload(org.primefaces.event.FileUploadEvent event)
```
    Uploads and stores the file.
    
    Parameters:
    
    event - the event containing the file
  - cableArticleImportTest
```
public void cableArticleImportTest()
```
    Performs a test of the cable article import from the file that was last uploaded.
  - cableArticleImport
```
public void cableArticleImport()
```
    Performs the cable article import from the file that was last uploaded.
  - getCableArticleSheetWithImportedCableArticles
```
public org.primefaces.model.StreamedContent getCableArticleSheetWithImportedCableArticles()
```
    Returns:
    
    the cable article sheet with cable articles that were just imported
  - getCableArticleSheetWithCableArticlesToExport
```
public org.primefaces.model.StreamedContent getCableArticleSheetWithCableArticlesToExport()
```
    Returns:
    
    the cable article sheet with the cable articles from cableArticlesToExport list
  - getImportTemplate
```
public org.primefaces.model.StreamedContent getImportTemplate()
```
    Returns:
    
    the cable article import template
  - isEditButtonEnabled
```
public boolean isEditButtonEnabled()
```
    Returns:
    
    true if edit cable article button is enabled, otherwise false.
  - isDeleteButtonEnabled
```
public boolean isDeleteButtonEnabled()
```
    Returns:
    
    true if delete cable article button is enabled, otherwise false.
  - getRequestedCableArticleName
```
public String getRequestedCableArticleName()
```
  - setRequestedCableArticleName
```
public void setRequestedCableArticleName(String requestedCableArticleName)
```
  - isCableArticleRequested
```
public boolean isCableArticleRequested()
```
  - getCableArticles
```
public List<CableArticleUI> getCableArticles()
```
    Returns:
    
    the cable articles to be displayed
  - getFilteredCableArticles
```
public List<CableArticleUI> getFilteredCableArticles()
```
    Returns:
    
    the filtered cable articles to be displayed
  - setFilteredCableArticles
```
public void setFilteredCableArticles(List<CableArticleUI> filteredCableArticles)
```
    Parameters:
    
    filteredCableArticles - the filtered cable articles 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
  - filterCableArticles
```
public void filterCableArticles()
```
    Refreshes cable articles list based on filters.
  - getSelectedCableArticles
```
public List<CableArticleUI> getSelectedCableArticles()
```
    Returns:
    
    the currently selected cable articles, cannot return null
  - setSelectedCableArticles
```
public void setSelectedCableArticles(List<CableArticleUI> selectedCableArticles)
```
    Parameters:
    
    selectedCableArticles - the cable articles to select
  - clearSelectedCableArticles
```
public void clearSelectedCableArticles()
```
    Clears the current cable article 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(CableArticleColumnUI 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 cable articles 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 cable article dialog.
  - resetValues
```
public void resetValues()
```
    Reset values. May be used at e.g. close of delete dialog.
  - onCableArticleAdd
```
public void onCableArticleAdd()
```
    Event triggered when cable article is created.
  - prepareEditPopup
```
public void prepareEditPopup()
```
    Prepare for Edit cable article dialog.
  - onCableArticleEdit
```
public void onCableArticleEdit()
```
    Event triggered when cable article is updated.
  - getDeletedCableArticles
```
public List<CableArticleUI> getDeletedCableArticles()
```
    Returns:
    
    the list of deleted cable articles.
  - checkCableArticlesForDeletion
```
public void checkCableArticlesForDeletion()
```
    The method builds a list of cable articles that are already deleted. If the list is not empty, it is displayed to the user and the user is prevented from deleting them.
  - onCableArticleDelete
```
public void onCableArticleDelete()
```
    Event triggered when cable article is deleted.
  - isCableArticleManufacturerValid
```
public void isCableArticleManufacturerValid(javax.faces.context.FacesContext ctx,
                                            javax.faces.component.UIComponent component,
                                            Object value)
```
    Validate cable article manufacturer. Throws ValidatorException if invalid.
    
    Parameters:
    
    ctx - faces context
    
    component - ui component
    
    value - cable article manufacturer
  - isCableArticleExternalIdValid
```
public void isCableArticleExternalIdValid(javax.faces.context.FacesContext ctx,
                                          javax.faces.component.UIComponent component,
                                          Object value)
```
    Validate cable article external id. Throws ValidatorException if invalid.
    
    Parameters:
    
    ctx - faces context
    
    component - ui component
    
    value - cable article external id
  - isCableArticleErpNumberValid
```
public void isCableArticleErpNumberValid(javax.faces.context.FacesContext ctx,
                                         javax.faces.component.UIComponent component,
                                         Object value)
```
    Validate cable article epr number. Throws ValidatorException if invalid.
    
    Parameters:
    
    ctx - faces context
    
    component - ui component
    
    value - cable article epr number
  - isCableArticleShortNameExternalIdValid
```
public void isCableArticleShortNameExternalIdValid(javax.faces.context.FacesContext ctx,
                                                   javax.faces.component.UIComponent component,
                                                   Object value)
```
    Validate cable article short name . external id (name). Throws ValidatorException if invalid.
    
    Parameters:
    
    ctx - faces context
    
    component - ui component
    
    value - cable article short name . external id (name)
  - 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
  - getSelectedCableArticle
```
public CableArticleUI getSelectedCableArticle()
```
    Returns:
    
    the selected cable article
  - getEditCableArticle
```
public boolean getEditCableArticle()
```
    Return true if the current user can edit cable article, else false. Note check if username in cable freeze bypass usernames.
    
    Returns:
    
    true if the current user can edit cable article, 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<CableArticleColumnUI> getColumns()
```
    Returns current columns to show in cable article 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
  - getCableArticlesToExportSize
```
public int getCableArticlesToExportSize()
```
    Return counter for number of cable articles to be exported.
    
    Returns:
    
    number of cable articles to be exported
  - updateCableArticlesToExportSize
```
public void updateCableArticlesToExportSize()
```
    Update counter for number of cable articles to be exported.
  - canImportCableArticles
```
public boolean canImportCableArticles()
```
    Return true if the current user can import cable articles, else false. Note check if username in cable freeze bypass usernames.
    
    Returns:
    
    true if the current user can import cable articles, 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 cable article 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 cable article given query to filter for.
    
    Parameters:
    
    query - query to filter for
    
    Returns:
    
    suggestions for cable article given query to filter for.
  - tooltipForLink
```
public String tooltipForLink(String label,
                             String column,
                             String value)
```
    Return tooltip for cable article link.
    
    Parameters:
    
    label - label
    
    column - column
    
    value - (part of) tooltip
    
    Returns:
    
    tooltip for cable article link
  - tooltipForCableArticle
```
public String tooltipForCableArticle(CableArticleColumnUI column)
```
    Return tooltip for cable article column.
    
    Parameters:
    
    column - cable article column
    
    Returns:
    
    tooltip for cable article column
  - getStandardParts
```
public String[] getStandardParts()
```
    Returns:
    
    available standard parts.

Class CableArticleRequestManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CableArticleRequestManager

Method Detail

init

getFileToBeImportedExists

getCableArticlesToExport

getImportResult

clearImportState

cableArticleFileUpload

cableArticleImportTest

cableArticleImport

getCableArticleSheetWithImportedCableArticles

getCableArticleSheetWithCableArticlesToExport

getImportTemplate

isEditButtonEnabled

isDeleteButtonEnabled

getRequestedCableArticleName

setRequestedCableArticleName

isCableArticleRequested

getCableArticles

getFilteredCableArticles

setFilteredCableArticles

getGlobalFilter

setGlobalFilter

filterCableArticles

getSelectedCableArticles

setSelectedCableArticles

clearSelectedCableArticles

onPaginate

onPaginatePageSize

onToggle

isColumnVisible

isColumnVisible

unselectAllRows

onRowSelect

getIsAddPopupOpened

prepareAddPopup

resetValues

onCableArticleAdd

prepareEditPopup

onCableArticleEdit

getDeletedCableArticles

checkCableArticlesForDeletion

onCableArticleDelete

isCableArticleManufacturerValid

isCableArticleExternalIdValid

isCableArticleErpNumberValid

isCableArticleShortNameExternalIdValid

isFloatEntered

getSelectedCableArticle

getEditCableArticle

getDisplayDescription

setDisplayDescription

handleDisplayDescription

getDisplayService

setDisplayService

handleDisplayService

getDisplayComments

setDisplayComments

handleDisplayComments

resetDisplayView

getColumns

updateColumns

getNumberOfColumns

getCableArticlesToExportSize

updateCableArticlesToExportSize

canImportCableArticles

setLongTextOverlayHeader

getLongTextOverlayHeader

setLongTextOverlayContent

getLongTextOverlayContent

setLongOverlayURL

getLongOverlayURL

clearSelection

getNumberOfEntitiesPerPage

getRowNumber