org.assistments.service.manager.core

Interface ExternalReferenceManager

All Known Implementing Classes:

ExternalReferenceManagerImpl

public interface ExternalReferenceManager

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 targetId) Creates an ExternalReference to a particular entity.

Method Detail

persist

ExternalReference persist(ExternalReferenceType refType,
                          java.lang.String xref,
                          int targetId)
                   throws AlreadyExistsException

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

Parameters:

partnerRef - Partner reference

refType - Entity type

dbid - Database ID of the entity.

Returns:

The External Reference

Throws:

NotFoundException - If partnerRef was not found

AlreadyExistsException - If an external reference already exists for this entity

partnerPersist

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

Throws:

AlreadyExistsException

findByXinfo

ExternalReference findByXinfo(XInfo xinfo)
                       throws NotFoundException

Returns the ExternalReference for a particular entity

Parameters:

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

Returns:

The External Reference

Throws:

NotFoundException - If

findByXid

ExternalReference findByXid(ExternalReferenceType refType,
                            int xid)
                     throws NotFoundException

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. :-)

Throws:

NotFoundException

findByRef

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

Returns the ExternalReference for a particular entity.

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

InvalidPartnerException

findByTargetId

ExternalReference findByTargetId(ExternalReferenceType refType,
                                 int targetId)
                          throws NotFoundException

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.

Parameters:

refType - External reference type

targetId - Internal database ID of interest

Returns:

Throws:

NotFoundException

InvalidPartnerException

getRefType

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

Returns an external reference's type

Parameters:

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

Returns:

The entity type being referenced

Throws:

NotFoundException

InvalidPartnerException

partnerOwnsXinfo

boolean partnerOwnsXinfo(XInfo xinfo)

Returns whether a partner owns a particular reference

Parameters:

xinfo - The XPair of interest

Returns:

true if the external reference belongs to partnerRef; otherwise false

Throws:

InvalidPartnerException

disable

ExternalReference disable(ExternalReference er)
                   throws NotFoundException

Disables an external reference

Parameters:

er - External reference to disable

Returns:

Throws:

NotFoundException - If the specified External Reference does not exist

InvalidPartnerException

enable

ExternalReference enable(ExternalReference er)
                  throws NotFoundException

Parameters:

er -

Returns:

Throws:

NotFoundException

deactivate

void deactivate(ExternalReference er)
         throws NotFoundException

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.

Parameters:

xinfo - XPair to examine

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

InvalidPartnerException

getXId

int getXId(XInfo xinfo)

findByXrefs

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

Throws:

NotFoundException