com.rsmart.kuali.coeus.hr.service.adapter

Class PersistableBoMergeAdapter<T,X>

java.lang.Object

com.rsmart.kuali.coeus.hr.service.adapter.PersistableBoMergeAdapter<T,X>

Type Parameters:

T - type of KRA PersistableBusinessObject

X - type of JAXB import object

All Implemented Interfaces:

Comparator<T>

Direct Known Subclasses:

EntityAddressBoAdapter, EntityAffiliationBoAdapter, EntityEmailBoAdapter, EntityEmploymentBoAdapter, EntityNameBoAdapter, EntityPhoneBoAdapter, PersonAppointmentBoAdapter, PersonDegreeBoAdapter

public abstract class PersistableBoMergeAdapter<T,X>
extends Object
implements Comparator<T>

This manages all logic required to adapt an object from an HRImportRecord to a PersistableBusinessObject within the KIM domain model.

Author:

duffy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	boIsDefaultable track whether the type T implements Defaultable
protected boolean	boIsInactivatable track whether the type T implements Inactivatable

Constructor Summary

Constructors

Constructor and Description
PersistableBoMergeAdapter()

Method Summary

Modifier and Type	Method and Description
int	compare(T bo0, T bo1) Compare two objects of type T to impose a strict ordering.
abstract int	compareBOProperties(T bo0, T bo1) Implements comparison logic to allow sorting of BusinessObjects.
void	delete(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter, T bo) Implements the default delet logic for the business object.
abstract Class<T>	getBusinessObjectClass() This is a method which allows HRImportService to determine the specific type of business object handled by this class.
abstract Class<X>	getIncomingClass() This is a method which allows HRImportService to determine the specific type of incoming JAXB object handled by this class.
boolean	isBoDefaultable()
boolean	isBoInactivatable()
abstract T	newBO(String entityId) This is a factory method for the business object.
int	nullSafeCompare(String val0, String val1) Compare two strings accounting for null values.
int	nullSafeCompareIgnoreCase(String val0, String val1) Compare two strings accounting for null values, ignoring case.
T	save(int index, org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter, T bo) Implements the default save logic for the business object.
T	setFields(int index, T bo, X source) Provides a new default interface that provides the index of the business object within its collection.
abstract T	setFields(T bo, X source) This is the method which translates the incoming JAXB object to the business object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

boIsInactivatable

protected boolean boIsInactivatable

track whether the type T implements Inactivatable

boIsDefaultable

protected boolean boIsDefaultable

track whether the type T implements Defaultable

Constructor Detail

PersistableBoMergeAdapter

public PersistableBoMergeAdapter()

Method Detail

nullSafeCompare

public final int nullSafeCompare(String val0,
                                 String val1)

Compare two strings accounting for null values. nulls are replaced with empty Strings for the purposes of comparison.

Parameters:

val0 -

val1 -

Returns:

0 for equality; < 0 if val0 comes first, > 0 if val1 comes first

nullSafeCompareIgnoreCase

public final int nullSafeCompareIgnoreCase(String val0,
                                           String val1)

Compare two strings accounting for null values, ignoring case. nulls are replaced with empty Strings for the purposes of comparison.

Parameters:

val0 -

val1 -

Returns:

0 for equality; < 0 if val0 comes first, > 0 if val1 comes first

compare

public final int compare(T bo0,
                         T bo1)

Compare two objects of type T to impose a strict ordering.

Specified by:

compare in interface Comparator<T>

isBoInactivatable

public boolean isBoInactivatable()

isBoDefaultable

public boolean isBoDefaultable()

save

public T save(int index,
              org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter,
              T bo)

Implements the default save logic for the business object. This functionality is encapsulated in PersistableBoMergeAdapter so overrides can perform updates to dependent business objects. (c.f. @link com.rsmart.kuali.coeus.hr.service.adapter.impl.EntityEmploymentBoAdapter.save EntityEmploymentBoAdapter)

Parameters:

index - order of the business object in its collection

legacyDataAdapter -

bo -

delete

public void delete(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter,
                   T bo)

Implements the default delet logic for the business object. This functionality is encapsulated in PersistableBoMergeAdapter so overrides can perform updates to dependent business objects. (c.f. @link com.rsmart.kuali.coeus.hr.service.adapter.impl.EntityEmploymentBoAdapter.delete EntityEmploymentBoAdapter)

Parameters:

bo -

compareBOProperties

public abstract int compareBOProperties(T bo0,
                                        T bo1)

Implements comparison logic to allow sorting of BusinessObjects. This should return 0 if and only if all fields that are available in the XML import are equivalent. Fields that are not visible (eg. foreign key fields that relate dependant objects) should ***NOT*** be included in the comparison. Since the XML will never contain these deep identifiers including those foreign key references will cause all imports to fail equivalence tests and to be replaced on every import.

Parameters:

bo0 -

bo1 -

Returns:

newBO

public abstract T newBO(String entityId)

This is a factory method for the business object. All business objects handled by subclasses of PersistableBOMergeAdapter are dependent entities on the EntityBo. For this reason the entityId is passed in. It should be set on the underlying business object before return.

Parameters:

entityId -

Returns:

setFields

public abstract T setFields(T bo,
                            X source)

This is the method which translates the incoming JAXB object to the business object. It should be assumed that the business object is not null and is empty except for the entityId field.

Parameters:

bo -

source -

Returns:

setFields

public T setFields(int index,
                   T bo,
                   X source)

Provides a new default interface that provides the index of the business object within its collection. This way objects that encode their order can update that value (eg. EntityEmploymentBo)

Parameters:

index -

bo -

source -

Returns:

getBusinessObjectClass

public abstract Class<T> getBusinessObjectClass()

This is a method which allows HRImportService to determine the specific type of business object handled by this class. Type erasure prevents determining the type of the generic parameter T at runtime, so this explicit method is necessary.

Returns:

getIncomingClass

public abstract Class<X> getIncomingClass()

This is a method which allows HRImportService to determine the specific type of incoming JAXB object handled by this class. Type erasure prevents determining the type of the generic parameter X at runtime, so this explicit method is necessary.

Returns: