org.kuali.rice.krad.datadictionary

Interface InactivationBlockingMetadata

All Known Implementing Classes:

InactivationBlockingDefinition

public interface InactivationBlockingMetadata

This interface provides read-only metadata about inactivation blocking. This metadata object is associated with a data object. The source of this information often comes from the data dictionary file.

Author:

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

Method Summary

Modifier and Type	Method and Description
String	getBlockedAttributeName() The name of the attribute which is blocked by the blocking object.
Class<? extends BusinessObject>	getBlockedBusinessObjectClass() Deprecated. use getBlockedDataObjectClass() instead, there is no requirement that the blocked class must implement the deprecated BusinessObject interface.
Class<?>	getBlockedDataObjectClass() Returns the type of the data object that is blocked.
String	getBlockedReferencePropertyName() Deprecated. use getBlockedAttributeName() instead
Class<?>	getBlockingDataObjectClass() The type of the object that is blocking another record.
Class<? extends BusinessObject>	getBlockingReferenceBusinessObjectClass() Deprecated. use getBlockingDataObjectClass() instead, there is no requirement that the blocking class must implement the deprecated BusinessObject interface.
String	getInactivationBlockingDetectionServiceBeanName() The bean name of the service that is responsible for determining whether there are any records that block inactivation
String	getRelationshipLabel() Returns the human-meaningful name of the relationship

Method Detail

getBlockedReferencePropertyName

@Deprecated
String getBlockedReferencePropertyName()

Deprecated. use getBlockedAttributeName() instead

The property name of the reference on the blocked object which points to the blocking object.

Returns:

the name of the blocking reference

getBlockedAttributeName

String getBlockedAttributeName()

The name of the attribute which is blocked by the blocking object.

Returns:

the name of the blocked attribute

getBlockedBusinessObjectClass

@Deprecated
Class<? extends BusinessObject> getBlockedBusinessObjectClass()

Deprecated. use getBlockedDataObjectClass() instead, there is no requirement that the blocked class must implement the deprecated BusinessObject interface.

The type of the object that is blocked.

Returns:

the type of the business object that is blocked

getBlockedDataObjectClass

Class<?> getBlockedDataObjectClass()

Returns the type of the data object that is blocked.

Returns:

the type of the data object that is blocked, should never be null

getInactivationBlockingDetectionServiceBeanName

String getInactivationBlockingDetectionServiceBeanName()

The bean name of the service that is responsible for determining whether there are any records that block inactivation

getBlockingReferenceBusinessObjectClass

@Deprecated
Class<? extends BusinessObject> getBlockingReferenceBusinessObjectClass()

Deprecated. use getBlockingDataObjectClass() instead, there is no requirement that the blocking class must implement the deprecated BusinessObject interface.

The type of the object that is blocking another record.

Returns:

the type of the object that is blocking

getBlockingDataObjectClass

Class<?> getBlockingDataObjectClass()

The type of the object that is blocking another record.

Returns:

the type of the object that is blocking, should never be null

getRelationshipLabel

String getRelationshipLabel()

Returns the human-meaningful name of the relationship

Returns:

relationship label