Sonic Management API

com.sonicsw.mf.common.runtime
Interface ICollectiveOpStatus


public interface ICollectiveOpStatus

Contains the status of a collective invocation of an operation or a collective setup of an attribute.

See Also:
IAgentManagerProxy

Method Summary
 java.lang.String getComponentName(int compNum)
          Returns the name of the compNum-th component.
 int getCount()
          Returns the number of collection components that were operated on.
 java.lang.Object getReturnValue(int compNum)
          Returns the return value of the compNum-th operation.
 java.lang.Throwable getThrowable(int compNum)
          Returns the throwable object of a failed compNum-th operation.
 boolean operationIsSuccessful(int compNum)
          Returns true if the operation on the compNum-th component was successful.
 

Method Detail

getComponentName

java.lang.String getComponentName(int compNum)
Returns the name of the compNum-th component. The name is the same as would be returned from com.sonicsw.mf.common.runtime.IComponentIdentity.getCanonicalName.

Parameters:
compNum - the position of the component in the list
Returns:
the name of the compNum-th component

getCount

int getCount()
Returns the number of collection components that were operated on.

Returns:
the number of collection components

getReturnValue

java.lang.Object getReturnValue(int compNum)
Returns the return value of the compNum-th operation.

Parameters:
compNum - the position of the component in the list
Returns:
the return value of the compNum-th operation. null is returned if it's a void method (or an attribute setup). null is also returned if operationIsSuccessful(compNum) returns false.

getThrowable

java.lang.Throwable getThrowable(int compNum)
Returns the throwable object of a failed compNum-th operation.

Parameters:
compNum - the position of the component in the list
Returns:
Returns the throwable object of a failed compNum-th operation. null is also returned if operationIsSuccessful(compNum) returns true.

operationIsSuccessful

boolean operationIsSuccessful(int compNum)
Returns true if the operation on the compNum-th component was successful.

Parameters:
compNum - the position of the component in the list
Returns:
true if the operation on the compNum-th component was successful

Sonic Management API

Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
HTML formatted on 13-Mar-2012.