public class CSMaintenanceAreaMultiple extends CSItemMultiple
CSMaintenanceAreaMultiple
class provides a method (get()
) that retrieves
the current online/offline status of various areas of iCM, details of those areas, and scheduled changes to the current status.
An optional comma-separated list parameter named 'areaList' containing the textual IDs of the areas to be retrieved may be supplied. If no list is specified then all areas will be retrieved.
A detail level of LEVEL_DETAIL returns information about areas. A detail level of LEVEL_ALL returns information about areas plus any scheduled changes.
LEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
CSMaintenanceAreaMultiple()
Creates an empty
CSMaintenanceAreaMultiple object. |
CSMaintenanceAreaMultiple(java.lang.String strPropertyFile)
Creates a new
CSMaintenanceAreaMultiple , specifying a properties files that contains all of the database
connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSMaintenanceAreaMultiple . |
boolean |
exist()
Not currently implemented for
CSMaintenanceAreaMultiple . |
void |
get()
Retrieves the details of the current online/offline status of various areas of iCM, details of those areas,
and scheduled changes to the current status.
|
java.lang.String |
getAreaList()
Gets the optional list of textual area identifiers specified as key information.
|
void |
setAreaList(java.lang.String strAreaList)
Specifies the optional list of textual area identifiers specified as key information of the areas whose details are to be retrieved.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
java.lang.String |
toString()
Outputs the contents of this
CSMaintenanceAreaMultiple object to a String object in a
user-friendly format. |
void |
update()
Not currently implemented for
CSMaintenanceAreaMultiple . |
equals, getItems, getMaxRows, getSortOrder, getStartRow, iterator, setItems, setMaxRows, setSortOrder, setStartRow
clearRecordedGatewayMessages, clone, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache
public CSMaintenanceAreaMultiple()
CSMaintenanceAreaMultiple
object.
Use the various set
methods provided to initialise the CSMaintenanceAreaMultiple
object prior
to invoking any of its query methods.
public CSMaintenanceAreaMultiple(java.lang.String strPropertyFile)
CSMaintenanceAreaMultiple
, specifying a properties files that contains all of the database
connection details.
Use the various set methods provided to initialise the CSMaintenanceAreaMultiple
object prior to invoking any
of its query manipulation methods.
strPropertyFile
- the property file that contains the connection details.public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method.
Valid detail levels for a maintenance area are :
LEVEL_DETAIL
Retrieves all area details.
LEVEL_ALL
Retrieves all area details plus related schedules.
setDetailLevel
in class CSDatabaseItem
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public void setAreaList(java.lang.String strAreaList)
setAreaList
followed by a call to get
returns details of the maintenance areas specified in the
list.
strAreaList
- a comma-separated list of maintenance area IDs.public java.lang.String getAreaList()
public void update() throws CSException
CSMaintenanceAreaMultiple
.
update
in class CSItemMultiple
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if one of the specified maintenance areas cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSMaintenanceAreaMultiple
.
delete
in class CSItemMultiple
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if one of the specified maintenance areas cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public boolean exist() throws CSException
CSMaintenanceAreaMultiple
.
exist
in class CSItemMultiple
true
if all maintenance areas exist on the database.CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSException
- the base class for exceptions thrown by this method.public void get() throws CSException
Use setAreaList
followed by get
to populate this
CSMaintenanceAreaMultiple
object with the details of the CSMaintenanceAreas specified in the list.
The retrieved maintenance areas will appear within CSMaintenanceAreaMultiple
in an order dictated by Area, then Online status.
Each retrieved maintenance area is stored as a CSMaintenanceArea
object within the item ArrayList
member
of CSMaintenanceAreaMultiple
- use getItems
or iterator
to
access/navigate through them.
get
in class CSItemMultiple
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if one of the specified maintenance areas cannot be found on the database.CSSecurityException
- if security has been breached.CSException
- the base class for exceptions thrown by this method.public java.lang.String toString()
CSMaintenanceAreaMultiple
object to a String
object in a
user-friendly format.
toString
in class CSItemMultiple
String
containing the user-friendly output.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.