org.kuali.rice.krad.service

Interface InactivationBlockingDetectionService

All Known Implementing Classes:

InactivationBlockingDetectionServiceImpl

public interface InactivationBlockingDetectionService

This service detects whether there are any records that block the inactivation of a particular record

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<?>	detectAllBlockingRecords(Object dataObject, InactivationBlockingMetadata inactivationBlockingMetadata) Detects all records in the relationship defined in the given metadata that prevents inactivation of the given data object.
boolean	detectBlockingRecord(Object dataObject, InactivationBlockingMetadata inactivationBlockingMetadata) Detects if there is ANY record in the relationship defined in the given metadata that prevents inactivation of the given data object.
boolean	hasABlockingRecord(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata) Deprecated. use detectBlockingRecord(Object, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata)
Collection<BusinessObject>	listAllBlockerRecords(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata) Deprecated. use detectAllBlockingRecords(Object, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata)

Method Detail

hasABlockingRecord

@Deprecated
boolean hasABlockingRecord(BusinessObject blockedBo,
                                    InactivationBlockingMetadata inactivationBlockingMetadata)

Deprecated. use detectBlockingRecord(Object, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata)

Determines whether there is ANY record in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo

Parameters:

blockedBo - a BO that is potentially inactivation blocked

inactivationBlockingMetadata -

Returns:

true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata

detectBlockingRecord

boolean detectBlockingRecord(Object dataObject,
                           InactivationBlockingMetadata inactivationBlockingMetadata)

Detects if there is ANY record in the relationship defined in the given metadata that prevents inactivation of the given data object.

Parameters:

dataObject - data object to check for inactivation blocking

inactivationBlockingMetadata - metadata to use for the inactivation blocking check

Returns:

true if there is any record which would block inactivation of the given data object, false otherwise

Throws:

IllegalArgumentException - if either dataObject or inactivationBlockingMetadata is null

listAllBlockerRecords

@Deprecated
Collection<BusinessObject> listAllBlockerRecords(BusinessObject blockedBo,
                                                          InactivationBlockingMetadata inactivationBlockingMetadata)

Deprecated. use detectAllBlockingRecords(Object, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata)

Lists all records in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo

Parameters:

blockedBo - a BO that is potentially inactivation blocked

inactivationBlockingMetadata -

Returns:

true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata

detectAllBlockingRecords

Collection<?> detectAllBlockingRecords(Object dataObject,
                                     InactivationBlockingMetadata inactivationBlockingMetadata)

Detects all records in the relationship defined in the given metadata that prevents inactivation of the given data object.

Parameters:

dataObject - data object to check for inactivation blocking

inactivationBlockingMetadata - metadata to use for the inactivation blocking check

Returns:

an immutable list of records which are blocking inactivation of the given data object

Throws:

IllegalArgumentException - if either dataObject or inactivationBlockingMetadata is null