org.kuali.kra.award

Interface AwardTemplateSyncService

All Known Implementing Classes:

AwardTemplateSyncServiceImpl

public interface AwardTemplateSyncService

This class is used for sync AwardSponsorTemplate details to different Award Details Objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYNC_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
boolean	syncAwardToTemplate(AwardDocument awardDocument, AwardTemplateSyncScope[] scopes) This method is to sync a particular syncable list from award template
boolean	syncWillAlterData(AwardDocument awardDocument, AwardTemplateSyncScope scope) Method checks if a scope sync will alter existing data within the award when called with a specific scope.
boolean	templateContainsScopedData(AwardDocument awardDocument, AwardTemplateSyncScope scope) Method returns true if the award's award template contains data that would be synchronized in the provided scope.

Field Detail

SYNC_PROPERTY

static final String SYNC_PROPERTY

See Also:

Constant Field Values

Method Detail

syncAwardToTemplate

boolean syncAwardToTemplate(AwardDocument awardDocument,
                          AwardTemplateSyncScope[] scopes)

This method is to sync a particular syncable list from award template

Parameters:

award -

syncPropertyName - is the name of member variable to represent syncable list

Returns:

true if successful

syncWillAlterData

boolean syncWillAlterData(AwardDocument awardDocument,
                        AwardTemplateSyncScope scope)

Method checks if a scope sync will alter existing data within the award when called with a specific scope.

Parameters:

awardDocument - The award document to check.

scope - The scope to check.

Returns:

true if existing data will be lost, false otherwise.

templateContainsScopedData

boolean templateContainsScopedData(AwardDocument awardDocument,
                                 AwardTemplateSyncScope scope)

Method returns true if the award's award template contains data that would be synchronized in the provided scope.

Parameters:

awardDocument - The award document to check.

scope - The scope to check.

Returns:

true if the template contains data that would be synchronized.