org.assistments.service.manager.core.impl

Class ExternalReferenceManagerImpl

java.lang.Object

org.assistments.service.manager.core.impl.ExternalReferenceManagerImpl

All Implemented Interfaces:

ExternalReferenceManager

@Component
public class ExternalReferenceManagerImpl
extends java.lang.Object
implements ExternalReferenceManager

Constructor Summary

Constructors

Constructor and Description
ExternalReferenceManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	deactivate(ExternalReference er) Confirms that the xid and xref values in an XPair belong to current partner and are of the expected type.
ExternalReference	disable(ExternalReference er) Disables an external reference
ExternalReference	enable(ExternalReference er)
ExternalReference	findByRef(ExternalReferenceType refType, java.lang.String extRef) Returns the ExternalReference for a particular entity.
ExternalReference	findByTargetId(ExternalReferenceType refType, int targetId) Returns the ExternalReference for a particular database ID.
ExternalReference	findByXid(ExternalReferenceType refType, int xid) For internal use only by SDK Manager code.
ExternalReference	findByXinfo(XInfo xinfo) Returns the ExternalReference for a particular entity
java.util.List<ExternalReference>	findByXrefs(java.util.List<java.lang.String> xRefs, ExternalReferenceType xRefType)
ExternalReferenceType	getRefType(java.lang.String extRef) Returns an external reference's type
int	getXId(XInfo xinfo)
boolean	partnerOwnsXinfo(XInfo xinfo) Returns whether a partner owns a particular reference
ExternalReference	partnerPersist(int partnerId, java.lang.String xref)
ExternalReference	persist(ExternalReferenceType refType, java.lang.String xref, int targetDbid) Creates an ExternalReference to a particular entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalReferenceManagerImpl

public ExternalReferenceManagerImpl()

Method Detail

persist

public ExternalReference persist(ExternalReferenceType refType,
                                 java.lang.String xref,
                                 int targetDbid)
                          throws NotFoundException,
                                 AlreadyExistsException

Description copied from interface: ExternalReferenceManager

Creates an ExternalReference to a particular entity. The returned reference is specific to a particular partner.

Specified by:

persist in interface ExternalReferenceManager

Parameters:

refType - Entity type

Returns:

The External Reference

Throws:

NotFoundException - If partnerRef was not found

AlreadyExistsException - If an external reference already exists for this entity

partnerPersist

public ExternalReference partnerPersist(int partnerId,
                                        java.lang.String xref)
                                 throws AlreadyExistsException

Specified by:

partnerPersist in interface ExternalReferenceManager

Throws:

AlreadyExistsException

findByTargetId

public ExternalReference findByTargetId(ExternalReferenceType refType,
                                        int targetId)
                                 throws NotFoundException

Description copied from interface: ExternalReferenceManager

Returns the ExternalReference for a particular database ID. Partner applications do not (typically) have access to internal database IDs and consequently are not likely to use this method. Instead, its use is intended for ASSISTments Service administrator applications which do have access to internal IDs.

Specified by:

findByTargetId in interface ExternalReferenceManager

Parameters:

refType - External reference type

targetId - Internal database ID of interest

Returns:

Throws:

NotFoundException

findByXinfo

public ExternalReference findByXinfo(XInfo xinfo)
                              throws NotFoundException

Description copied from interface: ExternalReferenceManager

Returns the ExternalReference for a particular entity

Specified by:

findByXinfo in interface ExternalReferenceManager

Parameters:

xinfo - Contains the external reference info (an xid and xref) to locate the full reference

Returns:

The External Reference

Throws:

NotFoundException - If

findByRef

public ExternalReference findByRef(ExternalReferenceType refType,
                                   java.lang.String extRef)
                            throws NotFoundException

Description copied from interface: ExternalReferenceManager

Returns the ExternalReference for a particular entity.

Specified by:

findByRef in interface ExternalReferenceManager

Parameters:

refType - External reference type

extRef - The external reference (a UUID) of interest.

Returns:

The External Reference

Throws:

NotFoundException - If a match is not found

findByXid

public ExternalReference findByXid(ExternalReferenceType refType,
                                   int xid)
                            throws NotFoundException

Description copied from interface: ExternalReferenceManager

For internal use only by SDK Manager code.

SDK-based applications that use this method do so at their own peril of sudden and unexpected behavior and errors. :-)

Specified by:

findByXid in interface ExternalReferenceManager

Throws:

NotFoundException

getRefType

public ExternalReferenceType getRefType(java.lang.String extRef)
                                 throws NotFoundException

Description copied from interface: ExternalReferenceManager

Returns an external reference's type

Specified by:

getRefType in interface ExternalReferenceManager

Parameters:

extRef - The external reference (a UUID) of interest.

Returns:

The entity type being referenced

Throws:

NotFoundException

partnerOwnsXinfo

public boolean partnerOwnsXinfo(XInfo xinfo)

Description copied from interface: ExternalReferenceManager

Returns whether a partner owns a particular reference

Specified by:

partnerOwnsXinfo in interface ExternalReferenceManager

Parameters:

xinfo - The XPair of interest

Returns:

true if the external reference belongs to partnerRef; otherwise false

enable

public ExternalReference enable(ExternalReference er)
                         throws NotFoundException

Specified by:

enable in interface ExternalReferenceManager

Returns:

Throws:

NotFoundException

disable

public ExternalReference disable(ExternalReference er)
                          throws NotFoundException

Description copied from interface: ExternalReferenceManager

Disables an external reference

Specified by:

disable in interface ExternalReferenceManager

Parameters:

er - External reference to disable

Returns:

Throws:

NotFoundException - If the specified External Reference does not exist

deactivate

public void deactivate(ExternalReference er)
                throws NotFoundException

Description copied from interface: ExternalReferenceManager

Confirms that the xid and xref values in an XPair belong to current partner and are of the expected type. If XPair contains only one of the external values, the other is inserted as part of the confirmation process.

Specified by:

deactivate in interface ExternalReferenceManager

Throws:

NotFoundException - If either the xid or xref are not found, do not belong to the provided partner reference, or are of the wrong type

getXId

public int getXId(XInfo xinfo)

Specified by:

getXId in interface ExternalReferenceManager

findByXrefs

public java.util.List<ExternalReference> findByXrefs(java.util.List<java.lang.String> xRefs,
                                                     ExternalReferenceType xRefType)
                                              throws NotFoundException

Specified by:

findByXrefs in interface ExternalReferenceManager

Throws:

NotFoundException