PaP
Class RequestResult

java.lang.Object
  |
  +--PaP.RequestResult

All Implemented Interfaces:

java.io.Serializable

public class RequestResult

extends java.lang.Object

implements java.io.Serializable

All PaP operation returns this unified result object.

See Also:

Serialized Form

Field Summary

static int	FAIL Result of the operation is FAIL
java.lang.Object	objectValue Used when the returned value is an object
static int	OK Result of the operation is OK
boolean	removed After ActorPlugOut, true if the specified RoleSession was allowed to be removed
CapabilitySet	resCaps The current set of capabilities at plugged in actor
java.lang.String	resultCause Cause of the result of the operation
int	resultType Result of the operation
RoleSession	roleSession After ActorPlugIn, the freshly created RoleSession with the identifiers of the plugged in actors
java.lang.String	subscribeIdentifier After SubscribeRequest, the unique subscription identifier

Constructor Summary

RequestResult()
Creates a new positive RequestResult (OK).

RequestResult(int pResultType, java.lang.String pResultCause)
Creates a new RequestResult with the specified result and resultcause.

RequestResult(java.lang.String pResultCause)
Creates a new negative RequestResult (FAIL) with the specified resultcause.

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

OK

public static final int OK

Result of the operation is OK

FAIL

public static final int FAIL

Result of the operation is FAIL

resultType

public int resultType

Result of the operation

resultCause

public java.lang.String resultCause

Cause of the result of the operation

roleSession

public RoleSession roleSession

After ActorPlugIn, the freshly created RoleSession with the identifiers of the plugged in actors

resCaps

public CapabilitySet resCaps

The current set of capabilities at plugged in actor

removed

public boolean removed

After ActorPlugOut, true if the specified RoleSession was allowed to be removed

subscribeIdentifier

public java.lang.String subscribeIdentifier

After SubscribeRequest, the unique subscription identifier

objectValue

public java.lang.Object objectValue

Used when the returned value is an object

Constructor Detail

RequestResult

public RequestResult(int pResultType,
                     java.lang.String pResultCause)

Creates a new RequestResult with the specified result and resultcause.

Parameters:

pResultType - Specifies the type of result.

pResultCause - The cause of this result.

RequestResult

public RequestResult()

Creates a new positive RequestResult (OK).

RequestResult

public RequestResult(java.lang.String pResultCause)

Creates a new negative RequestResult (FAIL) with the specified resultcause.

Parameters:

pResultCause - The cause of the negative result.