CableUI (Cable Database 5.4.1 API)

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

All Implemented Interfaces:

Serializable
```
public class CableUI
extends Object
implements Serializable
```
CableUI is a presentation of Cable used in UI.

Author:

Sunil Sah

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CableUI(Cable cable)
Constructs UI object for given cable instance.

Constructors
Constructor and Description
`CableUI(Cable cable)` Constructs UI object for given cable instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`getApproved()`
`Cable`	`getCable()`
`CableArticle`	`getCableArticle()`
`String`	`getCableArticleUrl()`
`String`	`getCableClass()`
`String`	`getCableCondition()` Gets the condition of the CableUI.
`String`	`getCablePropertyCondition(String columnLabel)` Gets condition of the CableUI property.
`CableType`	`getCableType()`
`String`	`getCableTypeUrl()`
`String`	`getChessId()`
`String`	`getComments()`
`String`	`getContainer()`
`String`	`getContainerUrl()`
`String`	`getCreated()`
`String`	`getDeviceURL(String columnLabel)` Returns the URL that the currently selected column points to.
`String`	`getElectricalDocumentation()`
`Endpoint`	`getEndpointA()`
`Endpoint`	`getEndpointB()`
`String`	`getEndpointBuildingA()`
`String`	`getEndpointBuildingB()`
`Connector`	`getEndpointConnectorA()`
`String`	`getEndpointConnectorAUrl()`
`Connector`	`getEndpointConnectorB()`
`String`	`getEndpointConnectorBUrl()`
`String`	`getEndpointDeviceAUrl()`
`String`	`getEndpointDeviceBUrl()`
`String`	`getEndpointDeviceNameA()`
`String`	`getEndpointDeviceNameAFbsTag()`
`String`	`getEndpointDeviceNameB()`
`String`	`getEndpointDeviceNameBFbsTag()`
`String`	`getEndpointLabelA()`
`String`	`getEndpointLabelB()`
`String`	`getEndpointRackA()`
`String`	`getEndpointRackAFbsTag()`
`String`	`getEndpointRackB()`
`String`	`getEndpointRackBFbsTag()`
`String`	`getFbsTag()`
`Long`	`getId()`
`String`	`getInstallationBy()`
`Date`	`getInstallationByDate()`
`InstallationPackage`	`getInstallationPackage()`
`String`	`getInstallationPackageUrl()`
`String`	`getLocationA()`
`String`	`getLocationB()`
`String`	`getModified()`
`String`	`getName()`
`List<String>`	`getOwners()`
`String`	`getOwnersString()`
`String`	`getRevision()`
`Integer`	`getSeqNumber()`
`CableStatus`	`getStatus()`
`String`	`getSubsystem()`
`String`	`getSystem()`
`String`	`getTerminationBy()`
`Date`	`getTerminationByDate()`
`int`	`hashCode()`
`boolean`	`isContainerInvalid()` Checks if the container is invalid or not (to show warning icon on UI, or do not render it).
`boolean`	`isValid()`
`void`	`setCableArticle(CableArticle cableArticle)` Set the cable article.
`void`	`setCableClass(String cableClass)` Set the cable class letter.
`void`	`setCableType(CableType cableType)` Set the cable type.
`void`	`setComments(String comments)`
`void`	`setContainer(String container)`
`void`	`setElectricalDocumentation(String electricalDocumentation)`
`void`	`setEndpointA(Endpoint endpointA)` set the endpoint a of the cable
`void`	`setEndpointADeviceChessId(String deviceChessId)`
`void`	`setEndpointARackChessId(String rackChessId)`
`void`	`setEndpointB(Endpoint endpointB)` set the endpoint a of the cable
`void`	`setEndpointBDeviceChessId(String deviceChessId)`
`void`	`setEndpointBRackChessId(String rackChessId)`
`void`	`setEndpointBuildingA(String endpointBuildingA)` Set the building the endpoint a is at.
`void`	`setEndpointBuildingB(String endpointBuildingB)` Set the building the endpoint b is at.
`void`	`setEndpointConnectorA(Connector endpointConnectorA)` Set the endpoint A connector.
`void`	`setEndpointConnectorB(Connector endpointConnectorB)` Set the endpoint B connector.
`void`	`setEndpointDeviceNameA(String endpointDeviceNameA)` Set the name of the endpoint a device.
`void`	`setEndpointDeviceNameAFbsTag(String endpointDeviceNameAFbsTag)`
`void`	`setEndpointDeviceNameB(String endpointDeviceNameB)` Set the name of the endpoint b device.
`void`	`setEndpointDeviceNameBFbsTag(String endpointDeviceNameBFbsTag)`
`void`	`setEndpointLabelA(String endpointLabelA)` Set the endpoint a label of the cable.
`void`	`setEndpointLabelB(String endpointLabelB)` Set the endpoint b label of the cable.
`void`	`setEndpointRackA(String endpointRackA)` Set the rack the endpoint a is at.
`void`	`setEndpointRackAFbsTag(String endpointRackAFbsTag)`
`void`	`setEndpointRackB(String endpointRackB)` Set the rack the endpoint b is at.
`void`	`setEndpointRackBFbsTag(String endpointRackBFbsTag)`
`void`	`setFbsTag(String fbsTag)`
`void`	`setInstallationByDate(Date installationBy)` Set the date by which this cable is installed.
`void`	`setInstallationPackage(InstallationPackage installationPackage)`
`void`	`setOwners(List<String> owners)` Set the cable owner.
`void`	`setRevision(String revision)`
`void`	`setStatus(CableStatus status)`
`void`	`setSubsystem(String subsystem)` Set the cable subsystem digit.
`void`	`setSystem(String system)` Set the cable system digit.
`void`	`setTerminationByDate(Date terminationBy)` Set the date by which this cable is terminated.
`String`	`toString()`

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

- Constructor Detail
  - CableUI
```
public CableUI(Cable cable)
```
    Constructs UI object for given cable instance.
    
    Parameters:
    
    cable - cable instance
- Method Detail
  - getCable
```
public Cable getCable()
```
    Returns:
    
    the cable instance this wraps
  - getId
```
public Long getId()
```
    Returns:
    
    the cable database id.
  - getCreated
```
public String getCreated()
```
    Returns:
    
    the creation date of this cable as string
    
    See Also:
    
    Cable.getCreated()
  - getModified
```
public String getModified()
```
    Returns:
    
    the modification date of this cable as string
    
    See Also:
    
    Cable.getModified()
  - getSeqNumber
```
public Integer getSeqNumber()
```
    Returns:
    
    the cable sequential number
  - setSystem
```
public void setSystem(String system)
```
    Set the cable system digit.
    
    Parameters:
    
    system - cable system digit
  - getSystem
```
public String getSystem()
```
    Returns:
    
    the cable system digit
  - setSubsystem
```
public void setSubsystem(String subsystem)
```
    Set the cable subsystem digit.
    
    Parameters:
    
    subsystem - cable subsystem digit
  - getSubsystem
```
public String getSubsystem()
```
    Returns:
    
    the cable subsystem digit
  - setCableClass
```
public void setCableClass(String cableClass)
```
    Set the cable class letter.
    
    Parameters:
    
    cableClass - cable class letter
  - getCableClass
```
public String getCableClass()
```
    Returns:
    
    the cable class letter
  - setOwners
```
public void setOwners(List<String> owners)
```
    Set the cable owner.
    
    Parameters:
    
    owners - cable owners
  - getOwnersString
```
public String getOwnersString()
```
    Returns:
    
    the cable owners
  - getOwners
```
public List<String> getOwners()
```
    Returns:
    
    the cable owners
  - setCableArticle
```
public void setCableArticle(CableArticle cableArticle)
```
    Set the cable article.
    
    Parameters:
    
    cableArticle - cable article
  - getCableArticle
```
public CableArticle getCableArticle()
```
    Returns:
    
    the cable article
  - setCableType
```
public void setCableType(CableType cableType)
```
    Set the cable type.
    
    Parameters:
    
    cableType - cable type
  - getCableType
```
public CableType getCableType()
```
    Returns:
    
    the cable type
  - getName
```
public String getName()
```
    Returns:
    
    the cable number
  - getEndpointA
```
public Endpoint getEndpointA()
```
    Returns:
    
    the endpoint a of the cable
  - setEndpointA
```
public void setEndpointA(Endpoint endpointA)
```
    set the endpoint a of the cable
    
    Parameters:
    
    endpointA - endpoint to set
  - getLocationA
```
public String getLocationA()
```
    Returns:
    
    the location description of endpoint A
  - setEndpointDeviceNameA
```
public void setEndpointDeviceNameA(String endpointDeviceNameA)
```
    Set the name of the endpoint a device.
    
    Parameters:
    
    endpointDeviceNameA - the name of the endpoint a device
  - getEndpointDeviceNameA
```
public String getEndpointDeviceNameA()
```
    Returns:
    
    the name of the endpoint a device.
  - setEndpointBuildingA
```
public void setEndpointBuildingA(String endpointBuildingA)
```
    Set the building the endpoint a is at.
    
    Parameters:
    
    endpointBuildingA - the building the endpoint a is at
  - getEndpointBuildingA
```
public String getEndpointBuildingA()
```
    Returns:
    
    the building the endpoint a is at.
  - setEndpointRackA
```
public void setEndpointRackA(String endpointRackA)
```
    Set the rack the endpoint a is at.
    
    Parameters:
    
    endpointRackA - the rack the endpont a is at
  - getEndpointRackA
```
public String getEndpointRackA()
```
    Returns:
    
    the rack the endpoint a is at.
  - setEndpointConnectorA
```
public void setEndpointConnectorA(Connector endpointConnectorA)
```
    Set the endpoint A connector.
    
    Parameters:
    
    endpointConnectorA - endpoint A connector
  - getEndpointConnectorA
```
public Connector getEndpointConnectorA()
```
    Returns:
    
    the endpoint A connector.
  - setEndpointLabelA
```
public void setEndpointLabelA(String endpointLabelA)
```
    Set the endpoint a label of the cable.
    
    Parameters:
    
    endpointLabelA - endpoint a label of the cable
  - getEndpointLabelA
```
public String getEndpointLabelA()
```
    Returns:
    
    the endpoint a label of the cable
  - getEndpointB
```
public Endpoint getEndpointB()
```
    Returns:
    
    the endpoint b of the cable
  - setEndpointB
```
public void setEndpointB(Endpoint endpointB)
```
    set the endpoint a of the cable
    
    Parameters:
    
    endpointB - the endpoint to set
  - getLocationB
```
public String getLocationB()
```
    Returns:
    
    the location description of endpoint B
  - setEndpointDeviceNameB
```
public void setEndpointDeviceNameB(String endpointDeviceNameB)
```
    Set the name of the endpoint b device.
    
    Parameters:
    
    endpointDeviceNameB - the name of the endpoint b device
  - getEndpointDeviceNameB
```
public String getEndpointDeviceNameB()
```
    Returns:
    
    the name of the endpoint b device.
  - setEndpointBuildingB
```
public void setEndpointBuildingB(String endpointBuildingB)
```
    Set the building the endpoint b is at.
    
    Parameters:
    
    endpointBuildingB - the building the endpoint b is at
  - getEndpointBuildingB
```
public String getEndpointBuildingB()
```
    Returns:
    
    the building the endpoint b is at.
  - setEndpointRackB
```
public void setEndpointRackB(String endpointRackB)
```
    Set the rack the endpoint b is at.
    
    Parameters:
    
    endpointRackB - the rack the endpont b is at
  - getEndpointRackB
```
public String getEndpointRackB()
```
    Returns:
    
    the rack the endpoint b is at.
  - setEndpointConnectorB
```
public void setEndpointConnectorB(Connector endpointConnectorB)
```
    Set the endpoint B connector.
    
    Parameters:
    
    endpointConnectorB - endpoint B connector
  - getEndpointConnectorB
```
public Connector getEndpointConnectorB()
```
    Returns:
    
    the endpoint B connector.
  - setEndpointLabelB
```
public void setEndpointLabelB(String endpointLabelB)
```
    Set the endpoint b label of the cable.
    
    Parameters:
    
    endpointLabelB - endpoint b label of the cable
  - getEndpointLabelB
```
public String getEndpointLabelB()
```
    Returns:
    
    the endpoint b label of the cable
  - getInstallationBy
```
public String getInstallationBy()
```
    Returns:
    
    the date by which this cable is installed as string
    
    See Also:
    
    Cable.getInstallationBy()
  - setInstallationByDate
```
public void setInstallationByDate(Date installationBy)
```
    Set the date by which this cable is installed.
    
    Parameters:
    
    installationBy - the date by which this cable is installed.
  - getInstallationByDate
```
public Date getInstallationByDate()
```
    Returns:
    
    the date by which this cable is installed.
  - getTerminationBy
```
public String getTerminationBy()
```
    Returns:
    
    the date by which this cable is terminated as string
    
    See Also:
    
    Cable.getTerminationBy()
  - setTerminationByDate
```
public void setTerminationByDate(Date terminationBy)
```
    Set the date by which this cable is terminated.
    
    Parameters:
    
    terminationBy - the date by which this cable is terminated
  - getTerminationByDate
```
public Date getTerminationByDate()
```
    Returns:
    
    the date by which this cable is terminated.
  - getStatus
```
public CableStatus getStatus()
```
    Returns:
    
    the cable status
  - isValid
```
public boolean isValid()
```
    Returns:
    
    true if the cable data is valid, else false
  - getApproved
```
public boolean getApproved()
```
    Returns:
    
    true if cable is approved otherwise false.
  - getChessId
```
public String getChessId()
```
  - getContainer
```
public String getContainer()
```
  - setContainer
```
public void setContainer(String container)
```
  - getComments
```
public String getComments()
```
  - setComments
```
public void setComments(String comments)
```
  - getRevision
```
public String getRevision()
```
  - setRevision
```
public void setRevision(String revision)
```
  - getFbsTag
```
public String getFbsTag()
```
  - setFbsTag
```
public void setFbsTag(String fbsTag)
```
  - setEndpointDeviceNameAFbsTag
```
public void setEndpointDeviceNameAFbsTag(String endpointDeviceNameAFbsTag)
```
  - getEndpointDeviceNameAFbsTag
```
public String getEndpointDeviceNameAFbsTag()
```
  - setEndpointRackAFbsTag
```
public void setEndpointRackAFbsTag(String endpointRackAFbsTag)
```
  - getEndpointRackAFbsTag
```
public String getEndpointRackAFbsTag()
```
  - setEndpointADeviceChessId
```
public void setEndpointADeviceChessId(String deviceChessId)
```
  - setEndpointARackChessId
```
public void setEndpointARackChessId(String rackChessId)
```
  - setEndpointDeviceNameBFbsTag
```
public void setEndpointDeviceNameBFbsTag(String endpointDeviceNameBFbsTag)
```
  - getEndpointDeviceNameBFbsTag
```
public String getEndpointDeviceNameBFbsTag()
```
  - setEndpointRackBFbsTag
```
public void setEndpointRackBFbsTag(String endpointRackBFbsTag)
```
  - getEndpointRackBFbsTag
```
public String getEndpointRackBFbsTag()
```
  - setEndpointBDeviceChessId
```
public void setEndpointBDeviceChessId(String deviceChessId)
```
  - setEndpointBRackChessId
```
public void setEndpointBRackChessId(String rackChessId)
```
  - getElectricalDocumentation
```
public String getElectricalDocumentation()
```
  - setElectricalDocumentation
```
public void setElectricalDocumentation(String electricalDocumentation)
```
  - getInstallationPackage
```
public InstallationPackage getInstallationPackage()
```
  - setInstallationPackage
```
public void setInstallationPackage(InstallationPackage installationPackage)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getCableArticleUrl
```
public String getCableArticleUrl()
```
  - getCableTypeUrl
```
public String getCableTypeUrl()
```
  - getEndpointConnectorAUrl
```
public String getEndpointConnectorAUrl()
```
  - getEndpointConnectorBUrl
```
public String getEndpointConnectorBUrl()
```
  - getContainerUrl
```
public String getContainerUrl()
```
  - getEndpointDeviceAUrl
```
public String getEndpointDeviceAUrl()
```
  - getEndpointDeviceBUrl
```
public String getEndpointDeviceBUrl()
```
  - getInstallationPackageUrl
```
public String getInstallationPackageUrl()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - setStatus
```
public void setStatus(CableStatus status)
```
  - getCableCondition
```
public String getCableCondition()
```
    Gets the condition of the CableUI.
    
    Returns:
    
    condition of the calbe
  - getDeviceURL
```
public String getDeviceURL(String columnLabel)
```
    Returns the URL that the currently selected column points to.
    
    Parameters:
    
    columnLabel - the label of the property
    
    Returns:
    
    url of the selected column
  - getCablePropertyCondition
```
public String getCablePropertyCondition(String columnLabel)
```
    Gets condition of the CableUI property.
    
    Parameters:
    
    columnLabel - the label of the property
    
    Returns:
    
    condition of the property
  - isContainerInvalid
```
public boolean isContainerInvalid()
```
    Checks if the container is invalid or not (to show warning icon on UI, or do not render it).
    
    Returns:
    
    true if container is invalid

Class CableUI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CableUI

Method Detail

getCable

getId

getCreated

getModified

getSeqNumber

setSystem

getSystem

setSubsystem

getSubsystem

setCableClass

getCableClass

setOwners

getOwnersString

getOwners

setCableArticle

getCableArticle

setCableType

getCableType

getName

getEndpointA

setEndpointA

getLocationA

setEndpointDeviceNameA

getEndpointDeviceNameA

setEndpointBuildingA

getEndpointBuildingA

setEndpointRackA

getEndpointRackA

setEndpointConnectorA

getEndpointConnectorA

setEndpointLabelA

getEndpointLabelA

getEndpointB

setEndpointB

getLocationB

setEndpointDeviceNameB

getEndpointDeviceNameB

setEndpointBuildingB

getEndpointBuildingB

setEndpointRackB

getEndpointRackB

setEndpointConnectorB

getEndpointConnectorB

setEndpointLabelB

getEndpointLabelB

getInstallationBy

setInstallationByDate

getInstallationByDate

getTerminationBy

setTerminationByDate

getTerminationByDate

getStatus

isValid

getApproved

getChessId

getContainer

setContainer

getComments

setComments

getRevision

setRevision

getFbsTag

setFbsTag

setEndpointDeviceNameAFbsTag

getEndpointDeviceNameAFbsTag

setEndpointRackAFbsTag

getEndpointRackAFbsTag

setEndpointADeviceChessId

setEndpointARackChessId

setEndpointDeviceNameBFbsTag

getEndpointDeviceNameBFbsTag

setEndpointRackBFbsTag

getEndpointRackBFbsTag