Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sun.management.oss
Interface ManagedEntityValue

All Superinterfaces:
  AttributeAccess, java.lang.Cloneable, java.io.Serializable, SerializerFactory

All Known Subinterfaces:
  OperationalStatusMonitorByClassesValue, OperationalStatusMonitorByObjectsValue, OperationalStatusMonitorValue, PerformanceMonitorByClassesValue, PerformanceMonitorByObjectsValue, PerformanceMonitorValue

public interface ManagedEntityValue
extends AttributeAccess, java.io.Serializable, java.lang.Cloneable, SerializerFactory

The `ManagedEntityValue` interface is the base interface for all more detailed interfaces which represent any kind of object that is to be managed.

Classes which implement `ManagedEntityValue` or a sub interface of `ManagedEntityValue`. are also called value classes.

All classes implementing a value interface provide several ways to access the attributes:

- Attributes can be accessed through standard JavaBeans get/set (is/set) methods.
- Attributes can be accessed through the generic methods defined in Attribute Access
  - `public Object getAttributeValue(String attributeName)`
  - `public void setAttributeValue(String attributeName, Object newValue)`

  Field Summary
  `static java.lang.String` | `KEY` This String defines the attribute name for the `ManagedEntityKey` attribute.

  Method Summary
  `java.lang.Object` | `clone()` Return a deep copy of this value.
  `long` | `getLastUpdateVersionNumber()` Get the version number of the last update.
  `ManagedEntityKey` | `getManagedEntityKey()` Get the key for this object.
  `java.lang.String[]` | `getSettableAttributeNames()` Get names of all attributes which the server allows the client to set.
  `ManagedEntityKey` | `makeManagedEntityKey()` Manufacture a Key for this managed entity.
  `void` | `setLastUpdateVersionNumber(long lastUpdateNumber)` Set the last update version number.
  `void` | `setManagedEntityKey(ManagedEntityKey key)` Set a new key for this value object.

  Methods inherited from interface com.sun.management.oss.AttributeAccess
  `getAllPopulatedAttributes, getAttributeNames, getAttributeValue, getAttributeValues, getPopulatedAttributeNames, getSupportedOptionalAttributeNames, isFullyPopulated, isPopulated, setAttributeValue, setAttributeValues, unpopulateAllAttributes, unpopulateAttribute`

  Methods inherited from interface com.sun.management.oss.SerializerFactory
  `getSupportedSerializerTypes, makeSerializer`

  Field Detail

  ### KEY

      public static final java.lang.String KEY

    This String defines the attribute name for the `ManagedEntityKey` attribute. It's value is "managedEntityKey".

    See Also:
      Constant Field Values

  Method Detail

  ### clone

      public java.lang.Object clone()

    Return a deep copy of this value.

  ### getLastUpdateVersionNumber

      public long getLastUpdateVersionNumber()

    Get the version number of the last update.

  ### setLastUpdateVersionNumber

      public void setLastUpdateVersionNumber(long lastUpdateNumber)
                                      throws java.lang.IllegalArgumentException

    Set the last update version number. This field should never be set by the application client. Mutator is provided for Serialization and Deserialization purposes only.

    Parameters:
      `lastUpdateNumber` -
    Throws:
      `java.lang.IllegalArgumentException`

  ### getManagedEntityKey

      public ManagedEntityKey getManagedEntityKey()
                                           throws java.lang.IllegalStateException

    Get the key for this object. The key is unique over all objects.

    Returns:
      the key for this value object.
    Throws:
      `java.lang.IllegalStateException` - in case the key attribute is not populated.
    See Also:
      `ManagedEntityKey`

  ### setManagedEntityKey

      public void setManagedEntityKey(ManagedEntityKey key)
                               throws java.lang.IllegalArgumentException

    Set a new key for this value object.

    May be used when there is a need to search for an specific object using this value as a template.

    Parameters:
      `key` - the new value for the key
    Throws:
      `java.lang.IllegalArgumentException` - when the given key is not of correct type. Typically, subinterfaces of ManagedEntityValue have a corresponding subinterface of ManagedEntityKey. An implementing type of this sub key class might be expected as a parameter.

  ### makeManagedEntityKey

      public ManagedEntityKey makeManagedEntityKey()

    Manufacture a Key for this managed entity.

    Returns:
      a newly created empty key of the appropriate type.

  ### getSettableAttributeNames

      public java.lang.String[] getSettableAttributeNames()

    Get names of all attributes which the server allows the client to set.

    It is required to return a subset of the array returned by `getAttributeNames()`.

    Returns:
      the names of attributes that can be set by the client.

  Overview | Package | Class | Use | Tree | Deprecated | Index | Help
  PREV CLASS NEXT CLASS | FRAMES NO FRAMES
  SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD