org.kuali.kra.award.home

Annotation Type AwardSyncableList

@Retention(value=RUNTIME)
public @interface AwardSyncableList

This is an Annotation to represent any award syncable list properties

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class	syncClass Set this property to the Class within a list.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	impactSourceScopeEmpty
String	parentPropertyName Set this property to the variable name representing its parent.
boolean	removeMissingListElementsFromTarget
AwardTemplateSyncScope[]	scopes The scope(s) where the sync should take place.
String	syncMethodName If the sync functionality to be overwritten in the service, set the name of the method here and implement the same in service.
Class	syncSourceClass Set this property to the Class within the source list.

Element Detail

syncClass

public abstract Class syncClass

Set this property to the Class within a list. This should be set to the destination class. For eg: for List awardComments (in award ), it should be set to AwardComment.class

syncSourceClass

public abstract Class syncSourceClass

Set this property to the Class within the source list. For eg: for List in AwardTemplate, it should be set to AwardTemplateComment.class It will default to Object.class. This is used by the list sync methods to determine which isInScope method to call when syncing list objects.

Default:

java.lang.Object.class

parentPropertyName

public abstract String parentPropertyName

Set this property to the variable name representing its parent.

Default:

"award"

syncMethodName

public abstract String syncMethodName

If the sync functionality to be overwritten in the service, set the name of the method here and implement the same in service.

Default:

"defaultMethod"

scopes

public abstract AwardTemplateSyncScope[] scopes

The scope(s) where the sync should take place.

Default:

{}

removeMissingListElementsFromTarget

public abstract boolean removeMissingListElementsFromTarget

Default:

true

impactSourceScopeEmpty

public abstract boolean impactSourceScopeEmpty

Default:

true