|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.datapower.wamt.clientAPI.ManagementStatus
public class ManagementStatus
Capture the management status (i.e., synced, in progress, etc.) for a managed element (firmware) on a device.
A ManagementStatus has no function, it is to be used only for display. Setting a ManagementStatus does not do anything. The ManagementStatus is set while management operations occur. It is to be used as an indicator of management function.
This class defines valid values for and provides helper methods for
aggregation of management status to higher levels. See the inner class
Enumerated
for a list of the possible values in this status.
When you read through those list of values it should give you a better idea
of what this class is trying to do.
Nested Class Summary | |
---|---|
static class |
ManagementStatus.Enumerated
The possible values for ManagementStatus . |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT_2009_2013
|
Constructor Summary | |
---|---|
ManagementStatus(ManagementStatus.Enumerated currentStatus)
Create an object to store the ManagementStatus of an item, using the specified initial value. |
Method Summary | |
---|---|
void |
addException(java.lang.Exception newException)
Add an Exception to the ManagementStatus to keep a list of problems that may have been encountered. |
java.lang.String |
getDisplayName()
Get a human-readable name that represents this object, using the default locale This name may be used in user interfaces. |
java.lang.String |
getDisplayName(java.util.Locale locale)
Get a human-readable name that represents this object. |
java.lang.String |
getDisplayNameKey()
Get a key that represents the description of this object. |
ManagementStatus.Enumerated |
getEnum()
Get the current management status of the item that is being managed. |
java.lang.Exception[] |
getExceptions()
Get the list of exceptions that may have been encountered during management. |
void |
rollupFrom(ManagementStatus[] lowerLevelStati)
This contains the logic to walk through multiple lower-level status values to determine what the aggregated higher-level status value is. |
void |
setStatus(ManagementStatus.Enumerated newStatus)
Change the management status of the managed item to the new status. |
java.lang.String |
toString()
Get a String representation of this object for the purpose of debugging or tracing. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT_2009_2013
Constructor Detail |
---|
public ManagementStatus(ManagementStatus.Enumerated currentStatus)
currentStatus
- the initial management status of the item that is
being managed.Method Detail |
---|
public void setStatus(ManagementStatus.Enumerated newStatus)
public
access modifier because it needs to be invoked from
multiple packages.
newStatus
- the new management status of the item that is being
managed.public ManagementStatus.Enumerated getEnum()
public void addException(java.lang.Exception newException)
newException
- a problem that was encountered during managementpublic java.lang.Exception[] getExceptions()
public void rollupFrom(ManagementStatus[] lowerLevelStati)
this
object contains the
higher-level aggregated status, which is dependent on the lower-level
status. The rollup status in this
is the highest value
from the lower-level statuses, which means this object will be
overwritten, but the parameters will only be read.
lowerLevelStati
- the lower-level statuses to merge into the
aggregated higher-level status that the this
object
represents.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getDisplayNameKey()
public java.lang.String getDisplayName()
public java.lang.String getDisplayName(java.util.Locale locale)
locale
- The locale to be used in getting the human-readable name
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |