public class CSMaintenanceAreaContent extends CSItemContent
CSMaintenanceArea
object.
The set/get
methods within CSMaintenanceArea
provide access to this content data.
CSMaintenanceArea
,
Serialized FormConstructor and Description |
---|
CSMaintenanceAreaContent()
Creates an empty
CSMaintenanceAreaContent object. |
Modifier and Type | Method and Description |
---|---|
CSItemContent |
createInstance()
Creates a new
CSMaintenanceAreaContent object and returns it as a CSItemContent , its superclass. |
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSMaintenanceAreaContent object is the same as that contained
within the one supplied. |
java.lang.String |
getArea()
Returns the textual id of a maintenance area
|
java.lang.String |
getDisplayArea()
Returns the user friendly name of the area
|
java.lang.String |
getOfflineComment()
Returns a user friendly sentence that describes the maintenance area when it is online
|
java.lang.Boolean |
getOnline()
Returns whether the maintenance area is currently online
|
java.lang.String |
getOnlineComment()
Returns a user friendly sentence that describes the maintenance area when it is online
|
java.util.List<CSMaintenanceSchedule> |
getSchedules()
Returns an array of schedules relevant to this maintenance area.
|
void |
setArea(java.lang.String area)
Sets the area, the unique textual id of an area subject to maintenance.
|
void |
setDisplayArea(java.lang.String displayArea)
Sets the display area, the user friendly name of the area subject to maintenance.
|
void |
setOfflineComment(java.lang.String offlineComment)
Sets the offline comment, the user friendly sentence that describes the iCM area when it is offline.
|
void |
setOnline(java.lang.Boolean online)
Sets the online status, whether or not the area is deemed online.
|
void |
setOnlineComment(java.lang.String onlineComment)
Sets the online comment, the user friendly sentence that describes the iCM area when it is online.
|
void |
setSchedules(java.util.List<CSMaintenanceSchedule> schedulesForArea)
Sets a list of scheduled changes to the area.
|
java.lang.String |
toString()
Provides debug information on the contents of the
CSArticleContent object. |
clone, getID, setID, unset
public CSMaintenanceAreaContent()
CSMaintenanceAreaContent
object.public CSItemContent createInstance()
CSMaintenanceAreaContent
object and returns it as a CSItemContent
, its superclass.
This is used by the clone
method in CSItemContent
.
CSMaintenanceAreaContent
object.public java.lang.String getArea()
public java.lang.String getDisplayArea()
public java.lang.String getOnlineComment()
public java.lang.String getOfflineComment()
public java.lang.Boolean getOnline()
public java.util.List<CSMaintenanceSchedule> getSchedules()
Only returned if DetailLevel is LEVEL_ALL.
public void setArea(java.lang.String area)
area
- The unique textual id of an area subject to maintenance.public void setDisplayArea(java.lang.String displayArea)
displayArea
- The user friendly name of the area subject to maintenance.public void setOnlineComment(java.lang.String onlineComment)
onlineComment
- The user friendly sentence that describes the iCM area when it is online.public void setOfflineComment(java.lang.String offlineComment)
offlineComment
- Sets the offline comment, the user friendly sentence that describes the iCM area when it is offline.public void setOnline(java.lang.Boolean online)
online
- Whether or not the area is deemed online.public void setSchedules(java.util.List<CSMaintenanceSchedule> schedulesForArea)
schedulesForArea
- A list of scheduled changes to the area.public java.lang.String toString()
CSArticleContent
object.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSMaintenanceAreaContent
object is the same as that contained
within the one supplied. Note that the key data used for searching is not tested for equality.
equals
in class CSItemContent
obj
- the CSMaintenanceAreaContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.