com.viaoa.object

Class OAObjectKey

java.lang.Object

com.viaoa.object.OAObjectKey

All Implemented Interfaces:

Serializable, Comparable

public class OAObjectKey
extends Object
implements Serializable, Comparable

Used to represent the objectId properties of an OAObject.
It is used as the key when storing objects in a hashtable.
If the object key property is assigned it will be used, otherwise the guid is used for the hash code.

OAObjectKey overwrites equals() to work the following way:
if guid is equal then objects are equal. If property key is equal, then objects are equal, unless either of the objects being compared is new.

For more information about this package, see documentation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bEmpty
protected boolean	bNew
protected int	guid
protected int	hc

Constructor Summary

Constructors

Constructor and Description
OAObjectKey(int value)
OAObjectKey(long value)
OAObjectKey(OAObject obj)
OAObjectKey(OAObject parent, Object value) create a key for an object that has a parent.
OAObjectKey(Object... ids)
OAObjectKey(Object value)
OAObjectKey(Object[] ids, int guid, boolean bNew)
OAObjectKey(String value)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object obj)
boolean	equals(Object obj)
boolean	exactEquals(OAObjectKey key)
int	getGuid()
Object[]	getObjectIds()
int	hashCode()
boolean	isNew()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

hc

protected int hc

bNew

protected boolean bNew

guid

protected int guid

bEmpty

protected boolean bEmpty

Constructor Detail

OAObjectKey

public OAObjectKey(Object... ids)

OAObjectKey

public OAObjectKey(Object[] ids,
                   int guid,
                   boolean bNew)

OAObjectKey

public OAObjectKey(OAObject obj)

OAObjectKey

public OAObjectKey(OAObject parent,
                   Object value)

create a key for an object that has a parent. Example: an Order that has/owns OrderItems: an OAObjectKey can be created for an OrderItem: new OAObjectKey(order, 1). This can be used to then find the OrderItem using a OADataSource.getObject(OrderItem.class, key) or HubController.get(OrderItem.class, key)

OAObjectKey

public OAObjectKey(Object value)

OAObjectKey

public OAObjectKey(int value)

OAObjectKey

public OAObjectKey(long value)

OAObjectKey

public OAObjectKey(String value)

Method Detail

getGuid

public int getGuid()

isNew

public boolean isNew()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

exactEquals

public boolean exactEquals(OAObjectKey key)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

getObjectIds

public Object[] getObjectIds()

toString

public String toString()

Overrides:

toString in class Object