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 ManagedEntityKeyResult

All Superinterfaces:
  java.io.Serializable

All Known Subinterfaces:
  OperationalStatusMonitorKeyResult, PerformanceMonitorKeyResult

public interface ManagedEntityKeyResult
extends java.io.Serializable

A base interface for every application specific `<ManagedEntity>KeyResult` interface.

A `<ManagedEntity>KeyResult` interface must comply with the following template:

     public interface <ManagedEntity>KeyResult extends ManagedEntityKeyResult
     {
         public <ManagedEntity>Key get<ManagedEntity>Key();
     }

The managed entity key result encapsulates all the information necessary to indicate the result of a BEST EFFORT operation on a specific managed entity.

The managed entity key result is used in operations involving the update of multiple managed entities, in the deletion of multiple managed entities or in the creation of multiple managed entities or in bulk business operations.

The base `ManagedEntityKeyResult` interface contains the managed entity key, a boolean value indicating if the operation on the targeted managed entity was succesful and finally the exception that would have been thrown if this operation had been attempted on the individual Managed Entity.

Method Summary
`java.lang.Exception` | `getException()` Returns the Exception associated with an operation failure.
`ManagedEntityKey` | `getManagedEntityKey()` Return the Managed Entity Key for which an operation result is reported.
`boolean` | `isSuccess()` Returns the success state of the operation.
`void` | `setException(java.lang.Exception ex)` Set the exception associated with an operation failure.
`void` | `setManagedEntityKey(ManagedEntityKey key)` Set the key of the managed entity targeted by the operation.
`void` | `setSuccess(boolean success)` Set the Success state of the operation.

Method Detail

### getManagedEntityKey

    public ManagedEntityKey getManagedEntityKey()

  Return the Managed Entity Key for which an operation result is reported.

  Returns:
    ManagedEntityKey

### isSuccess

    public boolean isSuccess()

  Returns the success state of the operation.

  Returns:
    true if operation was successful, false if it failed.

### getException

    public java.lang.Exception getException()

  Returns the Exception associated with an operation failure.

  Returns:
    the associated exception if the operation failed, `null` otherwise.

### setException

    public void setException(java.lang.Exception ex)
                      throws java.lang.IllegalArgumentException

  Set the exception associated with an operation failure.

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

### setManagedEntityKey

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

  Set the key of the managed entity targeted by the operation.

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

### setSuccess

    public void setSuccess(boolean success)
                    throws java.lang.IllegalArgumentException

  Set the Success state of the operation.

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

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