org.assistments.domain.core

Class XInfoImpl

java.lang.Object

org.assistments.domain.core.XInfoImpl

All Implemented Interfaces:

XInfo

Direct Known Subclasses:

Assignment, AssistmentsPrincipal, ExternalReference, Partner

public class XInfoImpl
extends java.lang.Object
implements XInfo

An XPair contains identifiers used by applications to reference SDK-persisted objects which are exposed to applications. Those object types are specified by the types included in ExternalReferenceType.

When an application persists one of those object types, by calling a Manager's persist() method, persist() returns the object updated with its externally available identifiers. Those identifiers are an:

• xid - an external ID, as a int, specific to the application that persists the object. While expected to be int-lived the SDK does not guarantee that these values are static over time. Consequently, SDK applications may choose to use xids in real-time, but they should not be persisted by the application for later use.
• xref - an external reference, as a UUID, specific the persisted object. These external references are guaranteed to be static over time. SDK applications that need to track objects persisted via the SDK should do so using the objects' xrefs.

In most use cases of an XPair, SDK methods accept an XPair containing either an xid or xref (as well as both). The method getState(XInfo) returns the enum XInfoImpl.XInfoState to revealing the state of an XPair

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XInfoImpl.XInfoState

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XInfoImpl(ExternalReferenceType type)
protected	XInfoImpl(ExternalReferenceType type, int xid)
protected	XInfoImpl(ExternalReferenceType type, int xid, java.lang.String xref)
protected	XInfoImpl(ExternalReferenceType type, java.lang.String xref)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asXinfoString()
void	clearXinfo() Sets this object's xid to 0 and xref to null.
boolean	equals(java.lang.Object obj) Returns whether two XInfos are equal based solely on the object's xref UUID.
PrincipalType	getPrincipalType()
static XInfoImpl.XInfoState	getState(XInfo xinfo)
ExternalReferenceType	getType()
int	getXid()
XInfo	getXinfo() Returns a new XInfoImpl instance containing the values returned from calling XInfo.getXid() and XInfo.getXref() on the implementing class.
java.lang.String	getXref()
int	hashCode() Returns an External Reference's hash code based solely on the object's xref UUID.
void	setXid(int xid) Sets the xid value for this object.
void	setXidOverride(int xid) Replaces the xid value for this object.
void	setXinfo(XInfo xinfo)
void	setXref(java.lang.String xref)
java.lang.String	toString()
java.lang.String	toString(java.lang.String indent)

Methods inherited from class java.lang.Object

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

Constructor Detail

XInfoImpl

protected XInfoImpl(ExternalReferenceType type)

XInfoImpl

protected XInfoImpl(ExternalReferenceType type,
                    int xid)

XInfoImpl

protected XInfoImpl(ExternalReferenceType type,
                    java.lang.String xref)

XInfoImpl

protected XInfoImpl(ExternalReferenceType type,
                    int xid,
                    java.lang.String xref)

Method Detail

getXid

public int getXid()

Specified by:

getXid in interface XInfo

setXid

public void setXid(int xid)

Description copied from interface: XInfo

Sets the xid value for this object.

Note: This method is intended for internal use by CAS only. Other than Unit Tests, it is unlikely that an application or service would need to call setXid(int xid). If you think you do need to call this method, speak to an experienced SDK developer

Specified by:

setXid in interface XInfo

Parameters:

xid - External Reference id value.

setXidOverride

public void setXidOverride(int xid)
                    throws java.lang.IllegalAccessError

Description copied from interface: XInfo

Replaces the xid value for this object.

Note: This method is for internal use by CAS only. It should never be called by an application or service. If you think you do need to call this method, speak to an experienced SDK developer

Specified by:

setXidOverride in interface XInfo

Parameters:

xid - New External Reference id value.

Throws:

java.lang.IllegalAccessError - if the current object does not already have an xid value. That is to say: If a call to XInfo.getXid() returns a non-zero value.

getXref

public java.lang.String getXref()

Specified by:

getXref in interface XInfo

setXref

public void setXref(java.lang.String xref)

Specified by:

setXref in interface XInfo

getXinfo

public XInfo getXinfo()

Description copied from interface: XInfo

Returns a new XInfoImpl instance containing the values returned from calling XInfo.getXid() and XInfo.getXref() on the implementing class.

Specified by:

getXinfo in interface XInfo

Returns:

A new XInfo instance.

setXinfo

public void setXinfo(XInfo xinfo)

Specified by:

setXinfo in interface XInfo

clearXinfo

public void clearXinfo()

Description copied from interface: XInfo

Sets this object's xid to 0 and xref to null.

Specified by:

clearXinfo in interface XInfo

getState

public static XInfoImpl.XInfoState getState(XInfo xinfo)

toString

public java.lang.String toString()

Specified by:

toString in interface XInfo

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: XInfo

Returns an External Reference's hash code based solely on the object's xref UUID.

Specified by:

hashCode in interface XInfo

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: XInfo

Returns whether two XInfos are equal based solely on the object's xref UUID.

Specified by:

equals in interface XInfo

Overrides:

equals in class java.lang.Object

asXinfoString

public java.lang.String asXinfoString()

Specified by:

asXinfoString in interface XInfo

toString

public java.lang.String toString(java.lang.String indent)

Specified by:

toString in interface XInfo

getType

public ExternalReferenceType getType()

Specified by:

getType in interface XInfo

getPrincipalType

public PrincipalType getPrincipalType()

Specified by:

getPrincipalType in interface XInfo