org.marketcetera.ors
Class Principals

java.lang.Object
  org.marketcetera.ors.Principals

public class Principals
extends Object

The principals associated with a trade report.

Since:

1.5.0

Version:

$Id: Principals.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

Field Summary

static Principals

UNKNOWN A sentinel value indicating unknown principals.

Constructor Summary

Principals(UserID actorID, UserID viewerID)
Creates a new principals container, for the given actor and viewer IDs.

Method Summary

boolean	equals(Object other)
UserID	getActorID() Returns the receiver's actor ID.
UserID	getViewerID() Returns the receiver's viewer ID.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNKNOWN

public static final Principals UNKNOWN

A sentinel value indicating unknown principals.

Constructor Detail

Principals

public Principals(UserID actorID,
                  UserID viewerID)

Creates a new principals container, for the given actor and viewer IDs.

Parameters:

actorID - The actorID. It may be null.

viewerID - The viewerID. It may be null.

Method Detail

getActorID

public UserID getActorID()

Returns the receiver's actor ID.

Returns:

The actor ID. It may be null.

getViewerID

public UserID getViewerID()

Returns the receiver's viewer ID.

Returns:

The viewer ID. It may be null.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object