All Packages  Class Hierarchy  This Package  Previous  Next  Index
  Class wrapper.Attribute
java.lang.Object
   |
   +----wrapper.Attribute
  -  public class Attribute
  -  extends Object
   
  -   COUNTER COUNTER
-  
  
-   COUNTER64 COUNTER64
-  
  
-   DATE DATE
-  
  
-   DISPLAYSTRING DISPLAYSTRING
-  
  
-   GAUGE GAUGE
-  
  
-   INTEGER INTEGER
-  
  
-   INTEGER64 INTEGER64
-  
  
-   OCTETSTRING OCTETSTRING
-  
  
-   READ_ONLY READ_ONLY
-  
  
-   READ_WRITE READ_WRITE
-  
  
-   UNKNOWN_ACCESS UNKNOWN_ACCESS
-  
  
-   UNSUPPORTED UNSUPPORTED
-  
  
-   WRITE_ONLY WRITE_ONLY
-  
   
  -   Attribute(Group, String, int, String, String, int, int) Attribute(Group, String, int, String, String, int, int)
-  Constructor.
   
  -   getAccessMode() getAccessMode()
-  Get related String for an access mode.
  
-   getDataType() getDataType()
-  Get related String for a data type.
  
-   getDescription() getDescription()
-  Get the description of this Attribute.
  
-   getID() getID()
-  Get the id of this Attribute.
  
-   getName() getName()
-  Get the name of this Attribute.
  
-   getValue() getValue()
-  Get the value of this Attribute.
  
-   refresh() refresh()
-  Update the value of this Attribute.
  
-   setValue(int, String) setValue(int, String)
-  Set the value of this Attribute.
  
-   toString() toString()
-  Attribute in String format.
   
 UNKNOWN_ACCESS
UNKNOWN_ACCESS
 public final int UNKNOWN_ACCESS
 READ_ONLY
READ_ONLY
 public final int READ_ONLY
 READ_WRITE
READ_WRITE
 public final int READ_WRITE
 WRITE_ONLY
WRITE_ONLY
 public final int WRITE_ONLY
 UNSUPPORTED
UNSUPPORTED
 public final int UNSUPPORTED
 COUNTER
COUNTER
 public final int COUNTER
 COUNTER64
COUNTER64
 public final int COUNTER64
 GAUGE
GAUGE
 public final int GAUGE
 INTEGER
INTEGER
 public final int INTEGER
 INTEGER64
INTEGER64
 public final int INTEGER64
 OCTETSTRING
OCTETSTRING
 public final int OCTETSTRING
 DISPLAYSTRING
DISPLAYSTRING
 public final int DISPLAYSTRING
 DATE
DATE
 public final int DATE
   
 Attribute
Attribute
 public Attribute(Group group,
                  String name,
                  int id,
                  String description,
                  String pragma,
                  int accessMode,
                  int dataType)
  -  Constructor.
   
- 
    -  Parameters:
    
-  group - The Group which contains this Attribute.
    -  name - The name of this Attribute.
    -  id - The id of this Attribute.
    -  description - The description of this Attribute.
    -  pragma - The pragma of this Attribute.
    -  accessMode - The access mode of this Attrivute.
                   E.g., Read-only, read-write, etc.
    -  dataType - The data type of this Attribute.
                 E.g., integer, date, string, etc.
  
 
   
 getName
getName
 public String getName()
  -  Get the name of this Attribute.
   
- 
    -  Returns:
    
-  A String as this Attribute's name.
  
 
 getID
getID
 public int getID()
  -  Get the id of this Attribute.
   
- 
    -  Returns:
    
-  An int as this Attribute's ID
  
 
 getDescription
getDescription
 public String getDescription()
  -  Get the description of this Attribute.
   
- 
    -  Returns:
    
-  A String as this Attribute's description.
  
 
 getValue
getValue
 public String getValue()
  -  Get the value of this Attribute.
   
- 
    -  Returns:
    
-  A String as the value of this Attribute.
  
 
 refresh
refresh
 public void refresh() throws DmiError
  -  Update the value of this Attribute.
   
- 
    -  Throws: DmiError
    
-  if cannot get the value of the attribute.
  
 
 setValue
setValue
 public void setValue(int setMode,
                      String value) throws DmiError
  -  Set the value of this Attribute.
   
- 
    -  Parameters:
    
-  setMode - The mode of setting, one of Set, Reserve and Release.
    -  value - A String as the value of this Attribute.
    
-  Throws: DmiError
    
-  if violate the access mode,
                     or cannot get the value correctly.
  
 
 toString
toString
 public String toString()
  -  Attribute in String format.
   
- 
    -  Returns:
    
-  A String indicateds id, name, description, pragma, access mode,
                             data type, and value.
    
-  Overrides:
    
-  toString in class Object
  
 
 getAccessMode
getAccessMode
 public String getAccessMode()
  -  Get related String for an access mode.
   
- 
    -  Returns:
    
-  A String indicates the access mode of this Attribute.
  
 
 getDataType
getDataType
 public String getDataType()
  -  Get related String for a data type.
   
- 
    -  Returns:
    
-  A String indicates the data Type of this Attribute.
  
 
All Packages  Class Hierarchy  This Package  Previous  Next  Index