org.assistments.service.manager.core

Interface PartnerManager

All Known Implementing Classes:

PartnerManagerImpl

public interface PartnerManager

The PartnerManager provides registration management of applications using the ASSISTments Service.

This manager is for use by the

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PartnerManager.UpdateField The UpdateField enum specifies the registration attributes a partner application controls and can modify by calling update(String, List).

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String partnerRef) Returns whether a partner reference exists (as a registered ASSISTments partner).
Partner	getMyPartner() Returns the current application's or service's Partner object originating from the PartnerCredentials as defined in the current application's configuration file (xml).
int	getMyPartnerId() Returns the current application's or service's Partner ID originating from persisted version of PartnerCredentials as defined in the current application's configuration file (xml).
java.lang.String	getMyPartnerRef() Returns the current application's or service's Partner external reference name originating from the PartnerCredentials as defined in the current application's configuration file (xml).
Partner	getPartner(java.lang.String partnerRef) Returns the Partner object for the named partner
int	getPartnerId(java.lang.String partnerRef) Returns the database ID for a partner reference Note: For use only by Service Administrators.
java.util.List<java.lang.String>	getPartnerReferences() Returns a list of all partner references
java.util.List<Partner>	getPartners()
Partner	getRequestingPartner() Returns the Partner object for the requesting application or service.
int	getRequestingPartnerId() Returns the persisted Partner ID for the requesting application or service.
java.lang.String	getRequestingPartnerRef() Returns the Partner reference for the requesting application or service.
java.util.List<Partner>	registerDependencies(PartnerCredentials pCreds)
Partner	registerOrUpdate(PartnerCredentials partnerCreds) Registers a new application with the ASSISTmetns Service (AS)
void	update(java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values)
void	update(java.lang.String partnerRef, java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values) Updates a partner application's select registration fields
void	updateRegistration(Partner partner) Updates a partner application's registration.

Method Detail

registerOrUpdate

Partner registerOrUpdate(PartnerCredentials partnerCreds)
                  throws AlreadyExistsException

Registers a new application with the ASSISTmetns Service (AS)

Only the AS admin applications is allowed to call this method.

Parameters:

partnerCreds - Partner application to register

Returns:

The resulting Partner object

Throws:

AlreadyExistsException - If partnerRef is already in use

registerDependencies

java.util.List<Partner> registerDependencies(PartnerCredentials pCreds)

updateRegistration

void updateRegistration(Partner partner)

Updates a partner application's registration.

Note: Presently for use only by System Administrators. Going forward, the API should allow partner applications to update a subset of their registration data.

Replaces all partner application fields with the values provided. The correct use of this method is to call getPartner(String), update the returned PartnerApplication object and to pass the updated object to this method.

Parameters:

partner - New settings

Throws:

InvalidPartnerException - If either adminRef or appRef is not valid

See Also:

getPartner(String)

exists

boolean exists(java.lang.String partnerRef)

Returns whether a partner reference exists (as a registered ASSISTments partner).

Note: For use only by Service Administrators.

Parameters:

partnerRef - Partner reference of interest

Returns:

true if partnerRef is a registered partner; otherwise false

getPartnerReferences

java.util.List<java.lang.String> getPartnerReferences()

Returns a list of all partner references

Returns:

The list of registered partner references Note: For use only by Service Administrators.

getPartners

java.util.List<Partner> getPartners()

getPartner

Partner getPartner(java.lang.String partnerRef)
            throws NotFoundException

Returns the Partner object for the named partner

Note: For use only by Service Administrators. For their application, partners call #getPartner().

Parameters:

partnerRef - Partner reference

Returns:

The Partner object for partnerRef

Throws:

NotFoundException - If the named application is not a registered partner.

getMyPartner

Partner getMyPartner()
              throws NotFoundException

Returns the current application's or service's Partner object originating from the PartnerCredentials as defined in the current application's configuration file (xml).

Note: Use with caution. In most cases you are interested in the requesting partner as your application is acting on behalf of that requestor. See getRequestingPartner().

Returns:

Partner object

Throws:

NotFoundException - If somehow the current application does not have a persisted entry. Unexpected.

getMyPartnerRef

java.lang.String getMyPartnerRef()

Returns the current application's or service's Partner external reference name originating from the PartnerCredentials as defined in the current application's configuration file (xml).

Note: Use with caution. In most cases you are interested in the requesting partner as your application is acting on behalf of that requestor. See getRequestingPartnerRef().

Returns:

The partner ref

Throws:

NotFoundException - If somehow the current application does not have a persisted entry. Unexpected.

getMyPartnerId

int getMyPartnerId()
            throws NotFoundException

Returns the current application's or service's Partner ID originating from persisted version of PartnerCredentials as defined in the current application's configuration file (xml).

Note: Use with caution. In most cases you are interested in the requesting partner as your application is acting on behalf of that requestor. See getRequestingPartnerId().

Returns:

Partner object

Throws:

NotFoundException - If somehow the current application does not have a persisted entry. Unexpected.

getRequestingPartner

Partner getRequestingPartner()
                      throws NotFoundException

Returns the Partner object for the requesting application or service.

Returns:

Requestor's Partner object

Throws:

NotFoundException - If the requestor presented an invalid partner reference.

getRequestingPartnerRef

java.lang.String getRequestingPartnerRef()
                                  throws NotFoundException

Returns the Partner reference for the requesting application or service.

Returns:

Requestor's Partner reference

Throws:

NotFoundException - If the requestor presented an invalid partner reference.

getRequestingPartnerId

int getRequestingPartnerId()
                    throws NotFoundException

Returns the persisted Partner ID for the requesting application or service.

Returns:

Requestor's Partner ID.

Throws:

NotFoundException - If the requestor presented an invalid partner reference.

getPartnerId

int getPartnerId(java.lang.String partnerRef)
          throws NotFoundException

Returns the database ID for a partner reference Note: For use only by Service Administrators. For their application, partners call #getPartnerId().

Parameters:

partnerRef - Partner reference of interest

Returns:

The database ID of partnerRef

Throws:

NotFoundException - If the specified partnerRef is not found

update

void update(java.lang.String partnerRef,
            java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values)

Updates a partner application's select registration fields

Parameters:

partnerRef - Partner application reference to update

values - List of fields and values to update

Throws:

InvalidPartnerException - If appRef is not valid.

update

void update(java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values)