org.kuali.kra.award

Class AwardTemplateSyncServiceImpl

java.lang.Object

org.kuali.kra.award.AwardTemplateSyncServiceImpl

All Implemented Interfaces:

AwardTemplateSyncService

public class AwardTemplateSyncServiceImpl
extends Object
implements AwardTemplateSyncService

This class is the implementation of AwardTemplateSyncService.

Field Summary

Fields inherited from interface org.kuali.kra.award.AwardTemplateSyncService

SYNC_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AwardTemplateSyncServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkSourceField(Object awardTemplateObject, Object awardObject, Field field, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate)
protected boolean	checkSourceList(Object awardTemplateObject, Object awardObject, Field field, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate)
protected boolean	checkTargetField(Object awardTemplateObject, Object awardObject, Field field, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This checks to see if a target field is null or otherwise empty.
protected boolean	checkTargetList(Object awardTemplateObject, Object awardObject, Field field, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) Check the target list, returns true if there is an element in the collection that is in scope.
protected AwardComment	clearListElement(AwardComment comment, Class syncClass, Award award, AwardTemplate awardTemplate)
protected void	copyField(Object awardTemplateObject, Object awardObject, Field field, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This copies value from Award Template object to Award object
protected Stack<AwardTemplateSyncScope[]>	createScopeStack() This method returns an empty scope stack.
protected void	extractListFromParentAndSync(Object awardTemplateObject, Object awardObject, Field field, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This method is for extracting the appropriate list from award by using property name and sync the list
protected AwardTemplate	fetchAwardTemplate(Award award) This method is to fetch the award template by using template code from Award object.
protected void	findAllFields(Class klass, List<Field> allFields) This method uses recursion to find all declared fields for a class hierierachy
protected Method	findIsInScopeMethodForClass(Class clazz)
protected AwardTemplateComment	findSourceListElementFromTarget(AwardComment comment, Map<Object,Object> sourceToTargetMap, Award award, AwardTemplate awardTemplate)
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the businessObjectService attribute.
protected Method	getClearExistingElementMethod(Class targetClass)
protected Method	getCreateNewListElementMethod(Class syncSourceClass) This method finds the appropriate getOrCreateNewListElementObject for a class.
protected AwardTemplateSyncScope[]	getEffectiveScope(Stack<AwardTemplateSyncScope[]> scopeStack) This method calculates the scope that should be used for an element given a scope stack.
protected Method	getFindSourceListElementFromTargetMethod(Class targetClass)
org.kuali.rice.krad.service.KualiRuleService	getKualiRuleService() Gets the kualiRuleService attribute.
protected AwardComment	getOrCreateNewListElementObject(AwardTemplateComment sourceComment, Class syncClass, Award award, AwardTemplate awardTemplate, boolean createNew)
protected AwardReportTermRecipient	getOrCreateNewListElementObject(AwardTemplateReportTermRecipient recipient, Class syncClass, Award award, AwardTemplate awardTemplate, boolean createNew)
protected AwardSponsorTerm	getOrCreateNewListElementObject(AwardTemplateTerm sponsorTerm, Class syncClass, Award award, AwardTemplate awardTemplate, boolean createNew)
protected Object	getOrCreateNewListElementObject(Object sourceObject, Class syncClass, Award award, AwardTemplate awardTemplate, boolean createNew)
protected AwardTemplateSyncScope[]	getScopeArray(AwardTemplateSyncScope scope) Get an array of AwardTemplateSyncScopes that should be used.
protected void	invokeMethodToSync(Award awardObject, List awardTemplateObjectList, String syncMethodName, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This method is to invoke individual method if there is a method mentioned in the AwardSyncableList annotation
static String	scopesArrayToDelimitedList(AwardTemplateSyncScope[] scopes) Utility method to generate a comma delimited list of scopes contained in the array passed in.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setKualiRuleService(org.kuali.rice.krad.service.KualiRuleService kualiRuleService) Sets the kualiRuleService attribute value.
protected void	sync(Object awardTemplateObject, Object awardObject, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This method is used to sync member properties of an award template object to an award object
void	syncAwardComments(Award awardObject, List<AwardTemplateComment> awardTemplateComments, Stack<AwardTemplateSyncScope[]> scopeStack) This is an overloaded method for syncing only AwardComments.
void	syncAwardSponsorTerms(Award awardObject, List<AwardTemplateTerm> awardTemplateTerms, Stack<AwardTemplateSyncScope[]> scopeStack) This is an overloaded method for syncing only AwardSponsorTerms.
boolean	syncAwardToTemplate(AwardDocument awardDocument, AwardTemplateSyncScope[] scopes) This method is to sync a particular syncable list from award template
protected void	syncListObjects(Object awardObject, List<Object> listObject, Field field, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This is the default method use to sync objects.
protected boolean	syncSourceCheck(Object awardTemplateObject, Object awardObject, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This method
protected boolean	syncTargetCheck(Object awardTemplateObject, Object awardObject, AwardTemplateSyncScope[] scopes, Stack<AwardTemplateSyncScope[]> scopeStack, Award award, AwardTemplate awardTemplate) This method
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwardTemplateSyncServiceImpl

public AwardTemplateSyncServiceImpl()

Method Detail

syncAwardToTemplate

public boolean syncAwardToTemplate(AwardDocument awardDocument,
                          AwardTemplateSyncScope[] scopes)

Description copied from interface: AwardTemplateSyncService

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

Specified by:

syncAwardToTemplate in interface AwardTemplateSyncService

Returns:

true if successful

See Also:

AwardTemplateSyncService.syncAwardToTemplate(org.kuali.kra.award.document.AwardDocument, org.kuali.kra.award.AwardTemplateSyncScope[])

syncWillAlterData

public boolean syncWillAlterData(AwardDocument awardDocument,
                        AwardTemplateSyncScope scope)

Description copied from interface: AwardTemplateSyncService

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

Specified by:

syncWillAlterData in interface AwardTemplateSyncService

Parameters:

awardDocument - The award document to check.

scope - The scope to check.

Returns:

true if existing data will be lost, false otherwise.

See Also:

AwardTemplateSyncService.syncWillAlterData(org.kuali.kra.award.document.AwardDocument, org.kuali.kra.award.AwardTemplateSyncScope)

templateContainsScopedData

public boolean templateContainsScopedData(AwardDocument awardDocument,
                                 AwardTemplateSyncScope scope)

Description copied from interface: AwardTemplateSyncService

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

Specified by:

templateContainsScopedData in interface AwardTemplateSyncService

Parameters:

awardDocument - The award document to check.

scope - The scope to check.

Returns:

true if the template contains data that would be synchronized.

See Also:

AwardTemplateSyncService.templateContainsScopedData(org.kuali.kra.award.document.AwardDocument, org.kuali.kra.award.AwardTemplateSyncScope)

getScopeArray

protected AwardTemplateSyncScope[] getScopeArray(AwardTemplateSyncScope scope)

Get an array of AwardTemplateSyncScopes that should be used. The rule is: if scope = FULL, then all values of AwardTemplateSyncScope.values() is used, otherwise an array with one element is returned.

Parameters:

scope - The scope

Returns:

The array of scopes that will be synchronized.

createScopeStack

protected Stack<AwardTemplateSyncScope[]> createScopeStack()

This method returns an empty scope stack. This stack is used to keep track of the sync scopes of each object as we traverse the object graph. The allows for the scope CONTAININIG_CLASS_INHERIT which for an element or list that will match the scopes of the containing class.

Returns:

a new Stack of AwardTemplateSyncScope

syncTargetCheck

protected boolean syncTargetCheck(Object awardTemplateObject,
                      Object awardObject,
                      AwardTemplateSyncScope[] scopes,
                      Stack<AwardTemplateSyncScope[]> scopeStack,
                      Award award,
                      AwardTemplate awardTemplate)
                           throws Exception

This method

Parameters:

awardTemplateObject -

awardObject -

Throws:

Exception

checkTargetField

protected boolean checkTargetField(Object awardTemplateObject,
                       Object awardObject,
                       Field field,
                       Stack<AwardTemplateSyncScope[]> scopeStack,
                       Award award,
                       AwardTemplate awardTemplate)
                            throws Exception

This checks to see if a target field is null or otherwise empty.

Parameters:

awardTemplateObject -

awardObject -

field -

Throws:

Exception

syncSourceCheck

protected boolean syncSourceCheck(Object awardTemplateObject,
                      Object awardObject,
                      AwardTemplateSyncScope[] scopes,
                      Stack<AwardTemplateSyncScope[]> scopeStack,
                      Award award,
                      AwardTemplate awardTemplate)
                           throws Exception

This method

Parameters:

awardTemplateObject -

awardObject -

Throws:

Exception

checkSourceField

protected boolean checkSourceField(Object awardTemplateObject,
                       Object awardObject,
                       Field field,
                       Stack<AwardTemplateSyncScope[]> scopeStack,
                       Award award,
                       AwardTemplate awardTemplate)

checkSourceList

protected boolean checkSourceList(Object awardTemplateObject,
                      Object awardObject,
                      Field field,
                      AwardTemplateSyncScope[] scopes,
                      Stack<AwardTemplateSyncScope[]> scopeStack,
                      Award award,
                      AwardTemplate awardTemplate)
                           throws Exception

Throws:

Exception

extractListFromParentAndSync

protected void extractListFromParentAndSync(Object awardTemplateObject,
                                Object awardObject,
                                Field field,
                                AwardTemplateSyncScope[] scopes,
                                Stack<AwardTemplateSyncScope[]> scopeStack,
                                Award award,
                                AwardTemplate awardTemplate)
                                     throws Exception

This method is for extracting the appropriate list from award by using property name and sync the list

Parameters:

awardTemplateObject -

awardObject -

propertyName -

awardSyncableList -

Throws:

Exception

getEffectiveScope

protected AwardTemplateSyncScope[] getEffectiveScope(Stack<AwardTemplateSyncScope[]> scopeStack)
                                              throws IllegalStateException

This method calculates the scope that should be used for an element given a scope stack. The rule is simple: Move down the stack until you reach an array that contains something other that CONTAINING_CLASS_INHERIT. If no such element exists in the stack we throw an exception.

Parameters:

scopeStack - The scope stack you want to get the effective scope for.

Returns:

An array representing the effective scope to be used.

Throws:

IllegalStateException - if there is no array in the stack that contains a scope other than CONTAINING_CLASS_INHERIT.

invokeMethodToSync

protected void invokeMethodToSync(Award awardObject,
                      List awardTemplateObjectList,
                      String syncMethodName,
                      AwardTemplateSyncScope[] scopes,
                      Stack<AwardTemplateSyncScope[]> scopeStack,
                      Award award,
                      AwardTemplate awardTemplate)
                           throws Exception

This method is to invoke individual method if there is a method mentioned in the AwardSyncableList annotation

Parameters:

awardObject -

awardTemplateObjectList -

syncMethodName -

Throws:

Exception

sync

protected void sync(Object awardTemplateObject,
        Object awardObject,
        AwardTemplateSyncScope[] scopes,
        Stack<AwardTemplateSyncScope[]> scopeStack,
        Award award,
        AwardTemplate awardTemplate)
             throws Exception

This method is used to sync member properties of an award template object to an award object

Parameters:

awardTemplateObject -

awardObject -

Throws:

Exception

findAllFields

protected void findAllFields(Class klass,
                 List<Field> allFields)

This method uses recursion to find all declared fields for a class hierierachy

Parameters:

klass -

allFields -

copyField

protected void copyField(Object awardTemplateObject,
             Object awardObject,
             Field field,
             Stack<AwardTemplateSyncScope[]> scopeStack,
             Award award,
             AwardTemplate awardTemplate)
                  throws Exception

This copies value from Award Template object to Award object

Parameters:

awardTemplateObject -

awardObject -

field -

Throws:

Exception

checkTargetList

protected boolean checkTargetList(Object awardTemplateObject,
                      Object awardObject,
                      Field field,
                      AwardTemplateSyncScope[] scopes,
                      Stack<AwardTemplateSyncScope[]> scopeStack,
                      Award award,
                      AwardTemplate awardTemplate)
                           throws Exception

Check the target list, returns true if there is an element in the collection that is in scope.

Parameters:

awardTemplateObject -

awardObject -

propertyName -

awardSyncableList -

Throws:

Exception

syncListObjects

protected void syncListObjects(Object awardObject,
                   List<Object> listObject,
                   Field field,
                   AwardTemplateSyncScope[] scopes,
                   Stack<AwardTemplateSyncScope[]> scopeStack,
                   Award award,
                   AwardTemplate awardTemplate)
                        throws Exception

This is the default method use to sync objects. This method is implemented to work on row Object. If we need to change the implementation of sync functionality for a specific list, we have to overload this method with specific type.

Parameters:

awardObject -

listObject -

objectInList -

field -

Throws:

Exception

getCreateNewListElementMethod

protected Method getCreateNewListElementMethod(Class syncSourceClass)

This method finds the appropriate getOrCreateNewListElementObject for a class. It does this by first trying to return the method within this implementation with the signature getOrCreateNewListElementObject( syncSourceClass, Class.class, Award.class, AwardTemplate.class ). If it does not find one, it returns the generic method getOrCreateNewListElementObject( Object.class, Class.class, Award.class, AwardTemplate.class ).

Parameters:

syncSourceClass - - The class you wish to find the method for. If a specific method for this class does not exist, the generic method is returned.

Returns:

The best match for the method.

getClearExistingElementMethod

protected Method getClearExistingElementMethod(Class targetClass)

getFindSourceListElementFromTargetMethod

protected Method getFindSourceListElementFromTargetMethod(Class targetClass)

getOrCreateNewListElementObject

protected Object getOrCreateNewListElementObject(Object sourceObject,
                                     Class syncClass,
                                     Award award,
                                     AwardTemplate awardTemplate,
                                     boolean createNew)

getOrCreateNewListElementObject

protected AwardComment getOrCreateNewListElementObject(AwardTemplateComment sourceComment,
                                           Class syncClass,
                                           Award award,
                                           AwardTemplate awardTemplate,
                                           boolean createNew)

clearListElement

protected AwardComment clearListElement(AwardComment comment,
                            Class syncClass,
                            Award award,
                            AwardTemplate awardTemplate)

findSourceListElementFromTarget

protected AwardTemplateComment findSourceListElementFromTarget(AwardComment comment,
                                                   Map<Object,Object> sourceToTargetMap,
                                                   Award award,
                                                   AwardTemplate awardTemplate)

getOrCreateNewListElementObject

protected AwardSponsorTerm getOrCreateNewListElementObject(AwardTemplateTerm sponsorTerm,
                                               Class syncClass,
                                               Award award,
                                               AwardTemplate awardTemplate,
                                               boolean createNew)

getOrCreateNewListElementObject

protected AwardReportTermRecipient getOrCreateNewListElementObject(AwardTemplateReportTermRecipient recipient,
                                                       Class syncClass,
                                                       Award award,
                                                       AwardTemplate awardTemplate,
                                                       boolean createNew)

findIsInScopeMethodForClass

protected Method findIsInScopeMethodForClass(Class clazz)

fetchAwardTemplate

protected AwardTemplate fetchAwardTemplate(Award award)

This method is to fetch the award template by using template code from Award object.

Parameters:

Award - object

Returns:

AwardTemplate object

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Gets the businessObjectService attribute.

Returns:

Returns the businessObjectService.

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

syncAwardComments

public void syncAwardComments(Award awardObject,
                     List<AwardTemplateComment> awardTemplateComments,
                     Stack<AwardTemplateSyncScope[]> scopeStack)

This is an overloaded method for syncing only AwardComments.

Parameters:

awardObject -

templateComments -

objectInList -

propertyName -

syncAwardSponsorTerms

public void syncAwardSponsorTerms(Award awardObject,
                         List<AwardTemplateTerm> awardTemplateTerms,
                         Stack<AwardTemplateSyncScope[]> scopeStack)

This is an overloaded method for syncing only AwardSponsorTerms.

Parameters:

awardObject -

templateTerms -

objectInList -

propertyName -

getKualiRuleService

public org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()

Gets the kualiRuleService attribute.

Returns:

Returns the kualiRuleService.

setKualiRuleService

public void setKualiRuleService(org.kuali.rice.krad.service.KualiRuleService kualiRuleService)

Sets the kualiRuleService attribute value.

Parameters:

kualiRuleService - The kualiRuleService to set.

scopesArrayToDelimitedList

public static final String scopesArrayToDelimitedList(AwardTemplateSyncScope[] scopes)

Utility method to generate a comma delimited list of scopes contained in the array passed in.

Parameters:

scopes -

Returns:

Comma delimited list of scope name contained in the passed in scopes array.