org.kuali.kra.award.awardhierarchy.sync.helpers

Interface AwardSyncHelper

All Known Implementing Classes:

AwardSyncAwardHelper, AwardSyncCommentsHelper, AwardSyncHelperBase, AwardSyncPersonHelper, AwardSyncReportHelper, AwardSyncReportRecipientHelper, AwardSyncSponsorContactHelper, AwardSyncTermHelper, AwardSyncUnitHelper

public interface AwardSyncHelper

Award Sync Helper interface. Describes the interface for classes that will be used to create and apply award sync changes.

Method Summary

Methods

Modifier and Type	Method and Description
void	applySyncChange(Award award, AwardSyncChange change) Applies the associated change to award.
AwardSyncXmlExport	buildXmlExport(org.kuali.rice.krad.bo.PersistableBusinessObject syncable, String attrName) Builds the xmlExport maps for syncable and an optional attrName including parent references.
AwardSyncChange	createAwardSyncChange(AwardSyncType syncType, org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject, String awardAttrName, String boAttrName) Create an award sync change for the syncableObject.

Method Detail

applySyncChange

void applySyncChange(Award award,
                   AwardSyncChange change)
                     throws NoSuchFieldException,
                            IllegalAccessException,
                            InvocationTargetException,
                            ClassNotFoundException,
                            NoSuchMethodException,
                            InstantiationException,
                            AwardSyncException

Applies the associated change to award.

Parameters:

award -

change -

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

ClassNotFoundException

NoSuchMethodException

InstantiationException

AwardSyncException

buildXmlExport

AwardSyncXmlExport buildXmlExport(org.kuali.rice.krad.bo.PersistableBusinessObject syncable,
                                String attrName)
                                  throws NoSuchFieldException,
                                         IllegalAccessException,
                                         InvocationTargetException

Builds the xmlExport maps for syncable and an optional attrName including parent references.

Parameters:

syncable -

attrName -

Returns:

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

createAwardSyncChange

AwardSyncChange createAwardSyncChange(AwardSyncType syncType,
                                    org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject,
                                    String awardAttrName,
                                    String boAttrName)
                                      throws NoSuchFieldException,
                                             IllegalAccessException,
                                             InvocationTargetException

Create an award sync change for the syncableObject.

Parameters:

syncType -

syncableObject -

awardAttrName - attribute on the award under which syncableObject can be found

boAttrName - attribute on the syncableObject that should be synced by this change

Returns:

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException