com.sas.edir
Class EventQueueKey

java.lang.Object
  |
  +--com.sas.edir.EventQueueKey

All Implemented Interfaces:

java.io.Serializable

public class EventQueueKey

extends java.lang.Object

implements java.io.Serializable

This is a simple class to use as a key for looking up items in the Event Queue.

Version:

1.0

Author:

SAS

See Also:

Serialized Form

Constructor Summary

EventQueueKey(java.lang.String userDn)
Construct an EventQueueKey.

EventQueueKey(java.lang.String userDn, java.lang.String uniqueID)
Construct an EventQueueKey

Method Summary

boolean	equals(EventQueueKey queueKey) Test another EventQueueKey to see if it's equal to this one.
java.lang.String	getUniqueID() Get the Unique ID
java.lang.String	getUserDn() Get the User's DN.
int	hashCode() Return a hash code for this key.
void	setUniqueID(java.lang.String uniqueID) Set the Unique ID
void	setUserDn(java.lang.String userDn) Set the User's DN.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventQueueKey

public EventQueueKey(java.lang.String userDn)

Construct an EventQueueKey.

Parameters:

userDn - The DN of the user a message is intended for

EventQueueKey

public EventQueueKey(java.lang.String userDn,
                     java.lang.String uniqueID)

Construct an EventQueueKey

Parameters:

userDn - The DN of the user a message is intended for.

uniqueID - An ID assigned to a specific report run.

Method Detail

getUserDn

public java.lang.String getUserDn()

Get the User's DN.

Returns:

A Distinguished Name.

setUserDn

public void setUserDn(java.lang.String userDn)

Set the User's DN.

Parameters:

userDN - A DN.

getUniqueID

public java.lang.String getUniqueID()

Get the Unique ID

Returns:

A unique identifier string for a report run.

setUniqueID

public void setUniqueID(java.lang.String uniqueID)

Set the Unique ID

Parameters:

uniqueID - A unique identifier for a report run.

equals

public boolean equals(EventQueueKey queueKey)

Test another EventQueueKey to see if it's equal to this one. If this uniqueID is null, don't test it. This makes the equals operation non-commutative. That is, a.equals(b) won't necessarily be the same as b.equals(a). since if a's unique ID is null, and b's isn't, a.equals(b) could be true, but b.equals(a) wouldn't be.

Parameters:

queueKey - Object to test for equivalence.

hashCode

public int hashCode()

Return a hash code for this key.

Overrides:

hashCode in class java.lang.Object

Returns:

An integer hash code.