CableRequestManager (Cable Database 5.4.1 API)

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

All Implemented Interfaces:

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

Author:

Vasu Vuppala, Sunil Sah, Marcel Salmic

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`CableRequestManager()` 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
`List<CableStatus>`	`allCableStatuses()` Lists cable statuses when reusing a cable on UI
`void`	`cableFileUpload(org.primefaces.event.FileUploadEvent event)` Uploads and stores the file.
`void`	`cableImport()` Performs the cable import from the file that was last uploaded.
`void`	`cableImportTest()` Performs a test of the cable import from the file that was last uploaded.
`boolean`	`canChangeStatus()` In order to determine if user can change status for selected cable
`boolean`	`canImportCables()`
`void`	`checkCablesForDeletion()` The method builds a list of cables that are already deleted.
`void`	`clearFillFromEnclosureEssName()` Clear and (possibly) fill From Enclosure ESS Name with value corresponding to From Enclosure FBS Tag, for selected cable.
`void`	`clearFillFromEnclosureFbsTag()` Clear and (possibly) fill From Enclosure FBS Tag with value corresponding to From Enclosure ESS Name, for selected cable.
`void`	`clearFillFromEssName()` Clear and (possibly) fill From ESS Name with value corresponding to From FBS Tag, for selected cable.
`void`	`clearFillFromFbsTag()` Clear and (possibly) fill From FBS Tag with value corresponding to From ESS Name, for selected cable.
`void`	`clearFillToEnclosureEssName()` Clear and (possibly) fill To Enclosure ESS Name with value corresponding to To Enclosure FBS Tag, for selected cable.
`void`	`clearFillToEnclosureFbsTag()` Clear and (possibly) fill To Enclosure FBS Tag with value corresponding to To Enclosure ESS Name, for selected cable.
`void`	`clearFillToEssName()` Clear and (possibly) fill To ESS Name with value corresponding to To FBS Tag, for selected cable.
`void`	`clearFillToFbsTag()` Clear and (possibly) fill To FBS Tag with value corresponding to To ESS Name, for selected cable.
`void`	`clearImportState()` Clears the import state.
`void`	`clearSelectedCables()` Clears the current cable selection.
`void`	`clearSelection()` Clears the newly created selected cable so editing is disabled
`List<String>`	`completeCableArticle(String query)` Autocomplete method for cable articles.
`List<String>`	`completeCableNames(String query)` Function used to autocomplete cable names to be reused
`List<String>`	`completeCableType(String query)` Autocomplete method for cable types.
`List<String>`	`completeConnectors(String query)` Autocomplete method for connectors.
`List<String>`	`completeDeviceNames(String query)` Autocomplete method for device names.
`List<String>`	`completeFbsTags(String query)` Return a list of FBS tags starting with given parameter.
`List<String>`	`completeFilter(CableColumnUI column)` Provide suggestions for cable given cable column.
`List<String>`	`completeFilter(String query)` Provide suggestions for cable given query to filter for.
`List<InstallationPackage>`	`completeInstallationPackage(String query)` Autocomplete method for installation packages.
`List<String>`	`completeUsers(String query)` Autocomplete method for users.
`void`	`conditionalClearCableType()` (Possibly) Clear cable type for selected cable.
`String`	`encodeURL(String url)` Encode a URL and return the encoded value.
`void`	`excuteQueryId(long id)` Execute query with given id
`void`	`executeQuery(javax.faces.event.ActionEvent e)` Execute selected query.
`List<javax.faces.model.SelectItem>`	`filterOptions(CableColumnUI column)` Provide filter options given cable column.
`List<InstallationPackage>`	`getAvailableInstallationPackages()`
`String[]`	`getCableClasses()`
`String`	`getCableNumberingSheetURL()`
`List<CableUI>`	`getCables()`
`org.primefaces.model.StreamedContent`	`getCableSheetWithCablesToExport()`
`org.primefaces.model.StreamedContent`	`getCableSheetWithImportedCables()`
`List<Cable>`	`getCablesToExport()` Returns the cables to be exported, which are the currently filtered and selected cables, or all filtered cables without deleted ones if none selected.
`Long`	`getCablesToExportSize()` Return counter for number of cables to be exported.
`String`	`getChessURL()`
`String`	`getDateFormatString()`
`List<CableUI>`	`getDeletedCables()`
`List<String>`	`getDeviceNames()`
`boolean`	`getEditCable()`
`boolean`	`getFileToBeImportedExists()`
`LoaderResult<Cable>`	`getImportResult()`
`org.primefaces.model.StreamedContent`	`getImportTemplate()`
`List<String>`	`getInstallationPackageNames()`
`boolean`	`getIsAddPopupOpened()`
`boolean`	`getIsAdmin()`
`boolean`	`getIsDisabledChangeCableName()` Return boolean about if ability to change cable name is disabled.
`boolean`	`getIsEmptyChessId()` Return true if chess id not set for selected cable.
`boolean`	`getIsEmptyDeviceA()`
`boolean`	`getIsEmptyDeviceAFbsTag()`
`boolean`	`getIsEmptyDeviceB()`
`boolean`	`getIsEmptyDeviceBFbsTag()`
`boolean`	`getIsRequiredArticle()` Return if cable article is required.
`boolean`	`getIsSystemSelected()`
`org.primefaces.model.LazyDataModel<CableUI>`	`getLazyModel()`
`String`	`getLongOverlayURL()`
`String`	`getLongTextOverlayContent()` Gets overlay content text.
`String`	`getLongTextOverlayHeader()` Gets overlay header text.
`static int`	`getNumberOfEntitiesPerPage()`
`String`	`getNumberOfFilteredItems()`
`List<CableStatus>`	`getPossibleCableStatus()`
`ReuseCableDetails`	`getReuseCableDetails()`
`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.
`CableUI`	`getSelectedCable()`
`String`	`getSelectedCableCableArticle()`
`String`	`getSelectedCableCableType()`
`String`	`getSelectedCableConnectorA()`
`String`	`getSelectedCableConnectorB()`
`String`	`getSelectedCableInstallationPackage()`
`String`	`getSelectedCableName()`
`List<String>`	`getSelectedCableOwners()`
`List<CableUI>`	`getSelectedCables()`
`String`	`getSelectedDevice()`
`QueryUI`	`getSelectedQuery()`
`SessionObject`	`getSessionObject()`
`String`	`getStyleCableFbsTag()` Return inline style of field for cable fbs tag.
`String`	`getStyleCableType()` Return style of cable type field.
`String[]`	`getSubsystems()`
`String[]`	`getSubsystems(String systemCharacter)` Return available subsystems for given system.
`String[]`	`getSystems()`
`void`	`init()` Initializes the bean for initial view display, and invokes service availability check at first invocation.
`void`	`initReuseCableDetails()` Initializes the object for reusing a cable
`boolean`	`isCableEdit(String value)` Check if parameter matches cable edit
`boolean`	`isCableEditable(CableUI cable)` Decides if a cable is locked-, or unlocked for editing for the currently logged in user.
`boolean`	`isCableLocked(Cable cable)` Decides if a cable cable can be edited, or not.
`boolean`	`isChangeCableOwnerAllowed()`
`boolean`	`isColumnVisible(CableColumnUI column)` Returns column visibility for given column.
`boolean`	`isColumnVisible(int columnIndex)` Returns column visibility for column with given index.
`boolean`	`isDeleteButtonEnabled()`
`boolean`	`isEditButtonEnabled()` Function to determine if Edit button can be enabled, or disabled for user
`boolean`	`isExportButtonEnabled()`
`void`	`isFloatEntered(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is Float number.
`boolean`	`isSingleCableSelected()`
`boolean`	`isUploadButtonEnabled()`
`void`	`isURLEntered(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is URL.
`void`	`isValidCableClass(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is not valid cable class.
`void`	`isValidLbsTag(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is valid LBS tag.
`void`	`isValidSubsystem(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is valid subsystem.
`void`	`isValidSystem(javax.faces.context.FacesContext ctx, javax.faces.component.UIComponent component, Object value)` Validates if entered value is valid system.
`boolean`	`linkToChess(CableUI cableUI, CableColumnUI cableColumnUI)` Return `boolean` if given information allows link to Chess.
`void`	`onCableAdd()` Event triggered when cable is created.
`void`	`onCableDelete()` Event triggered when cable is deleted.
`void`	`onCableEdit()` Event triggered when cable is updated.
`void`	`onCableEditApply()` Event triggered when cable is updated with apply.
`void`	`onPaginate()` Event triggered when paging for data table.
`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 dialog.
`void`	`prepareEditPopup()` Prepare for Edit cable dialog.
`void`	`redirect(String url, String page)` Redirects to the device extremities.
`void`	`redirectToCCDB(javax.faces.event.ActionEvent actionEvent)` Redirects to configuration cable database device extremities.
`void`	`redirectToNamingService(javax.faces.event.ActionEvent actionEvent)` Redirects to naming service device definition extremities.
`void`	`resetQuery()` Reset query and refresh cables.
`void`	`resetValues()` Reset values.
`String`	`retrieveCableClassLabel(String cableClass)` Return cable class name which corresponds to cable class letter.
`String`	`retrieveSubsystemLabel(String subsystemNumber)` Return subsystem name which corresponds to subsystem number.
`String`	`retrieveSystemLabel(String systemNumber)` Return system name which corresponds to system number.
`void`	`reuseCable()` Reuses the cable with desired parameters, and shows result on Message
`boolean`	`reuseCableNameButtonEnabled()` Determines if user can reuse a cable name
`void`	`setAvailableInstallationPackages(List<InstallationPackage> availableInstallationPackages)`
`void`	`setCables(List<CableUI> cables)`
`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`	`setRows(int rows)` Sets (current) number of rows/entries per page in pagination component.
`void`	`setSelectedCableCableArticle(String name)` Set selected cable cable article.
`void`	`setSelectedCableCableType(String name)` Set selected cable cable type.
`void`	`setSelectedCableConnectorA(String name)` Set selected cable connector A.
`void`	`setSelectedCableConnectorB(String name)` Set selected cable connector B.
`void`	`setSelectedCableInstallationPackage(String name)`
`void`	`setSelectedCableOwners(List<String> cableOwners)`
`void`	`setSelectedCables(List<CableUI> selectedCables)`
`void`	`setSelectedDevice(String selectedDevice)` Set selected device.
`void`	`setSelectedQuery(QueryUI selectedQuery)`
`void`	`setSessionObject(SessionObject sessionObject)`
`String`	`tooltipForEditLock(CableUI cable)` Tooltip util function for showing tooltip for cable Lock column.
`String`	`tooltipForEditMenu()` Tooltip util function for showing tooltip for cable Edit button.
`String`	`tooltipForLabel(CableColumnUI column)` Return tooltip for cable label.
`String`	`tooltipForLink(String label, String column, String value)` Return tooltip for cable link.
`String`	`tooltipForProblem(CableUI cableUi)` Generates the tooltip message when there is a problem with cable
`String`	`tooltipForValue(CableUI cable, String label, String column, String value)` Return tooltip for cable value.
`void`	`unselectAllRows()` Unselect all rows and proceed accordingly, i.e.
`void`	`updateCablesToExportSize()` Update counter for number of cables to be exported.
`void`	`validateCables()` Invokes explicit cable validation.

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

- Constructor Detail
  - CableRequestManager
```
public CableRequestManager()
```
    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.
  - initReuseCableDetails
```
public void initReuseCableDetails()
```
    Initializes the object for reusing a cable
  - canImportCables
```
public boolean canImportCables()
```
    Returns:
    
    true if the current user can import cables, else false
  - getFileToBeImportedExists
```
public boolean getFileToBeImportedExists()
```
    Returns:
    
    true if the uploaded file that hasn't been imported yet exists, false otherwise
  - getCables
```
public List<CableUI> getCables()
```
    Returns:
    
    the cables to be displayed
  - getSelectedCables
```
public List<CableUI> getSelectedCables()
```
    Returns:
    
    the currently selected cables, cannot return null
  - setSelectedCables
```
public void setSelectedCables(List<CableUI> selectedCables)
```
    Parameters:
    
    selectedCables - the cables to select
  - clearSelectedCables
```
public void clearSelectedCables()
```
    Clears the current cable selection.
  - getCablesToExport
```
public List<Cable> getCablesToExport()
```
    Returns the cables to be exported, which are the currently filtered and selected cables, or all filtered cables without deleted ones if none selected.
    
    Returns:
    
    the cables to be exported
  - getImportResult
```
public LoaderResult<Cable> getImportResult()
```
    Returns:
    
    the result of a test or true import
  - clearImportState
```
public void clearImportState()
```
    Clears the import state.
  - cableFileUpload
```
public void cableFileUpload(org.primefaces.event.FileUploadEvent event)
```
    Uploads and stores the file.
    
    Parameters:
    
    event - the event containing the file
  - cableImportTest
```
public void cableImportTest()
```
    Performs a test of the cable import from the file that was last uploaded.
  - cableImport
```
public void cableImport()
```
    Performs the cable import from the file that was last uploaded.
  - validateCables
```
public void validateCables()
```
    Invokes explicit cable validation.
  - getCableSheetWithImportedCables
```
public org.primefaces.model.StreamedContent getCableSheetWithImportedCables()
```
    Returns:
    
    the cable sheet with cables that were just imported
  - getCableSheetWithCablesToExport
```
public org.primefaces.model.StreamedContent getCableSheetWithCablesToExport()
```
    Returns:
    
    the cable sheet with the cables from cablesToExport list
  - getImportTemplate
```
public org.primefaces.model.StreamedContent getImportTemplate()
```
    Returns:
    
    the cable import template
  - getCableNumberingSheetURL
```
public String getCableNumberingSheetURL()
```
    Returns:
    
    the cable numbering sheet URL
  - getDateFormatString
```
public String getDateFormatString()
```
    Returns:
    
    the date format string to use to display dates
  - getSelectedDevice
```
public String getSelectedDevice()
```
    Returns:
    
    selected device.
  - setSelectedDevice
```
public void setSelectedDevice(String selectedDevice)
```
    Set selected device.
    
    Parameters:
    
    selectedDevice - selected device
  - onPaginate
```
public void onPaginate()
```
    Event triggered when paging for data table.
  - 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
    
    Returns:
    
    if column is visible
  - isColumnVisible
```
public boolean isColumnVisible(CableColumnUI 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 cables and row selection.
  - onRowSelect
```
public void onRowSelect()
```
    Event triggered when row is selected in table in UI.
  - isSingleCableSelected
```
public boolean isSingleCableSelected()
```
    Returns:
    
    true if a single cable is selected, false otherwise
  - getSelectedCableName
```
public String getSelectedCableName()
```
  - getIsEmptyChessId
```
public boolean getIsEmptyChessId()
```
    Return true if chess id not set for selected cable.
    
    Returns:
    
    true if chess id not set for selected cable
  - getStyleCableFbsTag
```
public String getStyleCableFbsTag()
```
    Return inline style of field for cable fbs tag.
    
    Returns:
    
    inline style of field for cable fbs tag
  - getIsRequiredArticle
```
public boolean getIsRequiredArticle()
```
    Return if cable article is required.
    
    Returns:
    
    if cable article is required
  - conditionalClearCableType
```
public void conditionalClearCableType()
```
    (Possibly) Clear cable type for selected cable.
  - getStyleCableType
```
public String getStyleCableType()
```
    Return style of cable type field.
    
    Returns:
    
    style of cable type field
  - getIsAddPopupOpened
```
public boolean getIsAddPopupOpened()
```
    Returns:
    
    true if add popup is opened otherwise false.
  - prepareAddPopup
```
public void prepareAddPopup()
```
    Prepare for Add cable dialog.
  - onCableAdd
```
public void onCableAdd()
```
    Event triggered when cable is created.
  - prepareEditPopup
```
public void prepareEditPopup()
```
    Prepare for Edit cable dialog.
  - onCableEdit
```
public void onCableEdit()
```
    Event triggered when cable is updated.
  - isCableEdit
```
public boolean isCableEdit(String value)
```
    Check if parameter matches cable edit
    
    Parameters:
    
    value - onCableAdd or onCableEdit
    
    Returns:
    
    true if if parameter matches cable edit
  - onCableEditApply
```
public void onCableEditApply()
```
    Event triggered when cable is updated with apply.
  - getDeletedCables
```
public List<CableUI> getDeletedCables()
```
    Returns:
    
    the list of deleted cables.
  - resetValues
```
public void resetValues()
```
    Reset values. May be used at e.g. close of delete dialog.
  - checkCablesForDeletion
```
public void checkCablesForDeletion()
```
    The method builds a list of cables that are already deleted. If the list is not empty, it is displayed to the user and the user is prevented from deleting them.
  - onCableDelete
```
public void onCableDelete()
```
    Event triggered when cable is deleted.
  - getSystems
```
public String[] getSystems()
```
    Returns:
    
    available systems.
  - getSubsystems
```
public String[] getSubsystems()
```
    Returns:
    
    available subsystems.
  - getSubsystems
```
public String[] getSubsystems(String systemCharacter)
```
    Return available subsystems for given system.
    
    Parameters:
    
    systemCharacter - system character (number)
    
    Returns:
    
    available subsystems for given system
  - getCableClasses
```
public String[] getCableClasses()
```
    Returns:
    
    available cables.
  - retrieveSystemLabel
```
public String retrieveSystemLabel(String systemNumber)
```
    Return system name which corresponds to system number.
    
    Parameters:
    
    systemNumber - system number
    
    Returns:
    
    system name which corresponds to system number
  - retrieveSubsystemLabel
```
public String retrieveSubsystemLabel(String subsystemNumber)
```
    Return subsystem name which corresponds to subsystem number.
    
    Parameters:
    
    subsystemNumber - subsystem number
    
    Returns:
    
    subsystem name which corresponds to subsystem number
  - retrieveCableClassLabel
```
public String retrieveCableClassLabel(String cableClass)
```
    Return cable class name which corresponds to cable class letter.
    
    Parameters:
    
    cableClass - cable class letter
    
    Returns:
    
    cable class name which corresponds to cable class letter
  - getIsSystemSelected
```
public boolean getIsSystemSelected()
```
    Returns:
    
    true if system is selected otherwise false.
  - getSelectedCable
```
public CableUI getSelectedCable()
```
    Returns:
    
    the selected cable.
  - getDeviceNames
```
public List<String> getDeviceNames()
```
    Returns:
    
    all available device names from naming service.
  - completeCableArticle
```
public List<String> completeCableArticle(String query)
```
    Autocomplete method for cable articles.
    
    Parameters:
    
    query - query to filter cable articles
    
    Returns:
    
    cable articles
  - completeCableType
```
public List<String> completeCableType(String query)
```
    Autocomplete method for cable types.
    
    Parameters:
    
    query - query to filter cable types
    
    Returns:
    
    cable types
  - completeDeviceNames
```
public List<String> completeDeviceNames(String query)
```
    Autocomplete method for device names.
    
    Parameters:
    
    query - query to filter device names
    
    Returns:
    
    device names
  - completeCableNames
```
public List<String> completeCableNames(String query)
```
    Function used to autocomplete cable names to be reused
    
    Parameters:
    
    query - part of the cable name that has to be searched for
    
    Returns:
    
    list of cableNames for UI autocompletion
  - completeFbsTags
```
public List<String> completeFbsTags(String query)
```
    Return a list of FBS tags starting with given parameter.
    
    Parameters:
    
    query - start of FBS tag
    
    Returns:
    
    list of FBS tags
  - completeConnectors
```
public List<String> completeConnectors(String query)
```
    Autocomplete method for connectors.
    
    Parameters:
    
    query - query to filter connectors
    
    Returns:
    
    connectors
  - getSelectedCableOwners
```
public List<String> getSelectedCableOwners()
```
    Returns:
    
    cable owners on selected cable
  - setSelectedCableOwners
```
public void setSelectedCableOwners(List<String> cableOwners)
```
    Parameters:
    
    cableOwners - cable owners to set on selected cable
  - completeUsers
```
public List<String> completeUsers(String query)
```
    Autocomplete method for users.
    
    Parameters:
    
    query - query to filter users
    
    Returns:
    
    users
  - getPossibleCableStatus
```
public List<CableStatus> getPossibleCableStatus()
```
    Returns:
    
    list of cable statuses that can be set to current cable.
  - canChangeStatus
```
public boolean canChangeStatus()
```
    In order to determine if user can change status for selected cable
    
    Returns:
    
    true if cable status can be changed, and false, if status can not be changed
  - getIsDisabledChangeCableName
```
public boolean getIsDisabledChangeCableName()
```
    Return boolean about if ability to change cable name is disabled.
    
    Returns:
    
    true if ability to change cable name is disabled
  - completeInstallationPackage
```
public List<InstallationPackage> completeInstallationPackage(String query)
```
    Autocomplete method for installation packages.
    
    Parameters:
    
    query - query to filter installation packages
    
    Returns:
    
    installation packages
  - getInstallationPackageNames
```
public List<String> getInstallationPackageNames()
```
  - getSelectedCableInstallationPackage
```
public String getSelectedCableInstallationPackage()
```
  - setSelectedCableInstallationPackage
```
public void setSelectedCableInstallationPackage(String name)
```
  - getSelectedCableCableArticle
```
public String getSelectedCableCableArticle()
```
    Returns:
    
    selected cable cable article.
  - setSelectedCableCableArticle
```
public void setSelectedCableCableArticle(String name)
```
    Set selected cable cable article.
    
    Parameters:
    
    name - cable article name (manufacturer.externalId)
  - getSelectedCableCableType
```
public String getSelectedCableCableType()
```
    Returns:
    
    selected cable cable type.
  - setSelectedCableCableType
```
public void setSelectedCableCableType(String name)
```
    Set selected cable cable type.
    
    Parameters:
    
    name - cable type name
  - getSelectedCableConnectorA
```
public String getSelectedCableConnectorA()
```
    Returns:
    
    selected cable connectorA.
  - setSelectedCableConnectorA
```
public void setSelectedCableConnectorA(String name)
```
    Set selected cable connector A.
    
    Parameters:
    
    name - connector name
  - getSelectedCableConnectorB
```
public String getSelectedCableConnectorB()
```
    Returns:
    
    selected cable connectorB.
  - setSelectedCableConnectorB
```
public void setSelectedCableConnectorB(String name)
```
    Set selected cable connector B.
    
    Parameters:
    
    name - connector name
  - isValidSystem
```
public void isValidSystem(javax.faces.context.FacesContext ctx,
                          javax.faces.component.UIComponent component,
                          Object value)
```
    Validates if entered value is valid system.
    
    Parameters:
    
    ctx - faces context
    
    component - component
    
    value - entered value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if entered value is not valid system
  - isValidSubsystem
```
public void isValidSubsystem(javax.faces.context.FacesContext ctx,
                             javax.faces.component.UIComponent component,
                             Object value)
```
    Validates if entered value is valid subsystem.
    
    Parameters:
    
    ctx - faces context
    
    component - component
    
    value - entered value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if entered value is not valid subsystem
  - isValidCableClass
```
public void isValidCableClass(javax.faces.context.FacesContext ctx,
                              javax.faces.component.UIComponent component,
                              Object value)
```
    Validates if entered value is not valid cable class.
    
    Parameters:
    
    ctx - faces context
    
    component - component
    
    value - entered value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if entered value is not valid cable class
  - isValidLbsTag
```
public void isValidLbsTag(javax.faces.context.FacesContext ctx,
                          javax.faces.component.UIComponent component,
                          Object value)
```
    Validates if entered value is valid LBS tag.
    
    Parameters:
    
    ctx - faces context
    
    component - component
    
    value - entered value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if entered value is not valid subsystem
  - 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
  - getEditCable
```
public boolean getEditCable()
```
    Returns:
    
    true if the current user can edit cables, else false
  - isEditButtonEnabled
```
public boolean isEditButtonEnabled()
```
    Function to determine if Edit button can be enabled, or disabled for user
    
    Returns:
    
    true if user can edit, and Edit button can be enabled false if user can not edit, and Edit button should be disabled
  - reuseCableNameButtonEnabled
```
public boolean reuseCableNameButtonEnabled()
```
    Determines if user can reuse a cable name
    
    Returns:
    
    true if user can reuse cableNames, and false if user can not reuse cableNames
  - isUploadButtonEnabled
```
public boolean isUploadButtonEnabled()
```
  - isChangeCableOwnerAllowed
```
public boolean isChangeCableOwnerAllowed()
```
  - isDeleteButtonEnabled
```
public boolean isDeleteButtonEnabled()
```
  - isExportButtonEnabled
```
public boolean isExportButtonEnabled()
```
  - redirectToCCDB
```
public void redirectToCCDB(javax.faces.event.ActionEvent actionEvent)
```
    Redirects to configuration cable database device extremities.
    
    Parameters:
    
    actionEvent - action event
  - redirectToNamingService
```
public void redirectToNamingService(javax.faces.event.ActionEvent actionEvent)
```
    Redirects to naming service device definition extremities.
    
    Parameters:
    
    actionEvent - action event
  - redirect
```
public void redirect(String url,
                     String page)
```
    Redirects to the device extremities.
    
    Parameters:
    
    url - URL to redirect to
    
    page - page to redirect to
  - filterOptions
```
public List<javax.faces.model.SelectItem> filterOptions(CableColumnUI column)
```
    Provide filter options given cable column.
    
    Parameters:
    
    column - cable column
    
    Returns:
    
    filter options given cable column
  - completeFilter
```
public List<String> completeFilter(CableColumnUI column)
```
    Provide suggestions for cable given cable column.
    
    Parameters:
    
    column - cable column
    
    Returns:
    
    suggestions for cable given cable column
  - completeFilter
```
public List<String> completeFilter(String query)
```
    Provide suggestions for cable given query to filter for.
    
    Parameters:
    
    query - query to filter for
    
    Returns:
    
    suggestions for cable given query to filter for.
  - 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 cables.
  - getNumberOfFilteredItems
```
public String getNumberOfFilteredItems()
```
  - setCables
```
public void setCables(List<CableUI> cables)
```
  - getLazyModel
```
public org.primefaces.model.LazyDataModel<CableUI> getLazyModel()
```
    Returns:
    
    the lazy loading data model
  - getCablesToExportSize
```
public Long getCablesToExportSize()
```
    Return counter for number of cables to be exported.
    
    Returns:
    
    number of cables to be exported
  - updateCablesToExportSize
```
public void updateCablesToExportSize()
```
    Update counter for number of cables to be exported.
  - getIsAdmin
```
public boolean getIsAdmin()
```
    Returns:
    
    true if current user is admin 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 conten 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.
  - getNumberOfEntitiesPerPage
```
public static int getNumberOfEntitiesPerPage()
```
  - getAvailableInstallationPackages
```
public List<InstallationPackage> getAvailableInstallationPackages()
```
  - setAvailableInstallationPackages
```
public void setAvailableInstallationPackages(List<InstallationPackage> availableInstallationPackages)
```
  - clearSelection
```
public void clearSelection()
```
    Clears the newly created selected cable so editing is disabled
  - getChessURL
```
public String getChessURL()
```
    Returns:
    
    the chess URL
  - linkToChess
```
public boolean linkToChess(CableUI cableUI,
                           CableColumnUI cableColumnUI)
```
    Return boolean if given information allows link to Chess.
    
    Parameters:
    
    cableUI - The cable UI component
    
    cableColumnUI - The cable column UI component
    
    Returns:
    
    Return boolean if given information allows link to Chess.
  - encodeURL
```
public String encodeURL(String url)
```
    Encode a URL and return the encoded value.
    
    Parameters:
    
    url - the url to encode
    
    Returns:
    
    the encoded value
    
    See Also:
    
    URLUtility.encodeURL(String)
  - 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
  - tooltipForProblem
```
public String tooltipForProblem(CableUI cableUi)
```
    Generates the tooltip message when there is a problem with cable
    
    Parameters:
    
    cableUi - cable
    
    Returns:
    
    the error-tooltip message
  - tooltipForValue
```
public String tooltipForValue(CableUI cable,
                              String label,
                              String column,
                              String value)
```
    Return tooltip for cable value.
    
    Parameters:
    
    cable - cable
    
    label - label
    
    column - column
    
    value - value
    
    Returns:
    
    tooltip for cable value
  - tooltipForLink
```
public String tooltipForLink(String label,
                             String column,
                             String value)
```
    Return tooltip for cable link.
    
    Parameters:
    
    label - label
    
    column - column
    
    value - (part of) tooltip
    
    Returns:
    
    tooltip for cable link
  - tooltipForLabel
```
public String tooltipForLabel(CableColumnUI column)
```
    Return tooltip for cable label.
    
    Parameters:
    
    column - cable column
    
    Returns:
    
    tooltip for cable label
  - getIsEmptyDeviceA
```
public boolean getIsEmptyDeviceA()
```
    Returns:
    
    whether Device A of selected cable is empty or not
  - getIsEmptyDeviceAFbsTag
```
public boolean getIsEmptyDeviceAFbsTag()
```
    Returns:
    
    whether Device A FBS Tag of selected cable is empty or not
  - getIsEmptyDeviceB
```
public boolean getIsEmptyDeviceB()
```
    Returns:
    
    whether Device B of selected cable is empty or not
  - getIsEmptyDeviceBFbsTag
```
public boolean getIsEmptyDeviceBFbsTag()
```
    Returns:
    
    whether Device B FBS Tag of selected cable is empty or not
  - clearFillFromEssName
```
public void clearFillFromEssName()
```
    Clear and (possibly) fill From ESS Name with value corresponding to From FBS Tag, for selected cable.
  - clearFillFromFbsTag
```
public void clearFillFromFbsTag()
```
    Clear and (possibly) fill From FBS Tag with value corresponding to From ESS Name, for selected cable.
  - clearFillFromEnclosureEssName
```
public void clearFillFromEnclosureEssName()
```
    Clear and (possibly) fill From Enclosure ESS Name with value corresponding to From Enclosure FBS Tag, for selected cable.
  - clearFillFromEnclosureFbsTag
```
public void clearFillFromEnclosureFbsTag()
```
    Clear and (possibly) fill From Enclosure FBS Tag with value corresponding to From Enclosure ESS Name, for selected cable.
  - clearFillToEssName
```
public void clearFillToEssName()
```
    Clear and (possibly) fill To ESS Name with value corresponding to To FBS Tag, for selected cable.
  - clearFillToFbsTag
```
public void clearFillToFbsTag()
```
    Clear and (possibly) fill To FBS Tag with value corresponding to To ESS Name, for selected cable.
  - clearFillToEnclosureEssName
```
public void clearFillToEnclosureEssName()
```
    Clear and (possibly) fill To Enclosure ESS Name with value corresponding to To Enclosure FBS Tag, for selected cable.
  - clearFillToEnclosureFbsTag
```
public void clearFillToEnclosureFbsTag()
```
    Clear and (possibly) fill To Enclosure FBS Tag with value corresponding to To Enclosure ESS Name, for selected cable.
  - getSessionObject
```
public SessionObject getSessionObject()
```
  - setSessionObject
```
public void setSessionObject(SessionObject sessionObject)
```
  - getReuseCableDetails
```
public ReuseCableDetails getReuseCableDetails()
```
  - reuseCable
```
public void reuseCable()
```
    Reuses the cable with desired parameters, and shows result on Message
  - allCableStatuses
```
public List<CableStatus> allCableStatuses()
```
    Lists cable statuses when reusing a cable on UI
    
    Returns:
    
    available cable statuses
  - tooltipForEditMenu
```
public String tooltipForEditMenu()
```
    Tooltip util function for showing tooltip for cable Edit button.
    
    Returns:
    
    tooltip string for Edit menu
  - tooltipForEditLock
```
public String tooltipForEditLock(CableUI cable)
```
    Tooltip util function for showing tooltip for cable Lock column. Generates different string for the menu if - cable is locked for editing - cable is not selected - cable is selected, and is not locked for editing for the user - user does not have privileges to edit cables
    
    Parameters:
    
    cable - cable for which to prepare tooltip for Lock column
    
    Returns:
    
    tooltip string for Lock column
  - isCableLocked
```
public boolean isCableLocked(Cable cable)
```
    Decides if a cable cable can be edited, or not. Cable with INSERTED status is unlocked, but any other status is locked
    
    Parameters:
    
    cable - the cable for which the lock state for editing has to be determined
    
    Returns:
    
    true if cable can be edited false if cable can not be edited
  - isCableEditable
```
public boolean isCableEditable(CableUI cable)
```
    Decides if a cable is locked-, or unlocked for editing for the currently logged in user.
    
    Parameters:
    
    cable - the cable for which the lock state for editing has to be determined
    
    Returns:
    
    true if cable editing is locked false if cable editing is unlocked

Class CableRequestManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CableRequestManager

Method Detail

init

initReuseCableDetails

canImportCables

getFileToBeImportedExists

getCables

getSelectedCables

setSelectedCables

clearSelectedCables

getCablesToExport

getImportResult

clearImportState

cableFileUpload

cableImportTest

cableImport

validateCables

getCableSheetWithImportedCables

getCableSheetWithCablesToExport

getImportTemplate

getCableNumberingSheetURL

getDateFormatString

getSelectedDevice

setSelectedDevice

onPaginate

onToggle

isColumnVisible

isColumnVisible

unselectAllRows

onRowSelect

isSingleCableSelected

getSelectedCableName

getIsEmptyChessId

getStyleCableFbsTag

getIsRequiredArticle

conditionalClearCableType

getStyleCableType

getIsAddPopupOpened

prepareAddPopup

onCableAdd

prepareEditPopup

onCableEdit

isCableEdit

onCableEditApply

getDeletedCables

resetValues

checkCablesForDeletion

onCableDelete

getSystems

getSubsystems

getSubsystems

getCableClasses

retrieveSystemLabel

retrieveSubsystemLabel

retrieveCableClassLabel

getIsSystemSelected

getSelectedCable

getDeviceNames

completeCableArticle

completeCableType

completeDeviceNames

completeCableNames

completeFbsTags

completeConnectors

getSelectedCableOwners

setSelectedCableOwners

completeUsers

getPossibleCableStatus

canChangeStatus

getIsDisabledChangeCableName

completeInstallationPackage

getInstallationPackageNames

getSelectedCableInstallationPackage

setSelectedCableInstallationPackage

getSelectedCableCableArticle