org.kuali.rice.krad.datadictionary

Class InactivationBlockingDefinition

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.krad.datadictionary.InactivationBlockingDefinition

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean, InactivationBlockingMetadata

public class InactivationBlockingDefinition
extends DataDictionaryDefinitionBase
implements InactivationBlockingMetadata

This is a description of what this class does - wliang don't forget to fill this in.

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	blockedBusinessObjectClass
protected String	blockedReferencePropertyName
protected Class<?>	blockingReferenceBusinessObjectClass
protected Class<?>	businessObjectClass
protected String	inactivationBlockingDetectionServiceBeanName
protected String	relationshipLabel

Fields inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

embeddedDataObjectMetadata, generatedFromMetadata, id

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
InactivationBlockingDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation(Class<?> rootDataObjectClass, Class<?> otherDataObjectClass, ValidationTrace tracer) Empty implementation so that all subclasses do not need to implement this method if they have no local validation to perform.
String	getBlockedAttributeName() The name of the attribute which is blocked by the blocking object.
Class<? extends BusinessObject>	getBlockedBusinessObjectClass() Deprecated.
Class<?>	getBlockedDataObjectClass() Returns the type of the data object that is blocked.
String	getBlockedReferencePropertyName() Deprecated.
Class<?>	getBlockingDataObjectClass() The type of the object that is blocking another record.
Class<? extends BusinessObject>	getBlockingReferenceBusinessObjectClass() Deprecated.
Class<? extends BusinessObject>	getBusinessObjectClass() Deprecated. the businessObjectClass does not appear to be used anywhere significantly internally or externally, no replacement
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
void	setBlockedAttributeName(String blockedAttributeName)
void	setBlockedBusinessObjectClass(Class<? extends BusinessObject> blockedBusinessObjectClass) Deprecated. use setBlockedDataObjectClass(Class) instead
void	setBlockedDataObjectClass(Class<?> blockedDataObjectClass)
void	setBlockedReferencePropertyName(String blockedReferencePropertyName) Deprecated. use setBlockedAttributeName(String) instead
void	setBlockingReferenceBusinessObjectClass(Class<? extends BusinessObject> blockingReferenceBusinessObjectClass) Deprecated. use setBlockingReferenceDataObjectClass(Class)
void	setBlockingReferenceDataObjectClass(Class<?> blockingDataObjectClass)
void	setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass) Deprecated. the businessObjectClass does not appear to be used anywhere significantly internally or externally, no replacement
void	setInactivationBlockingDetectionServiceBeanName(String inactivationBlockingDetectionServiceImpl)
void	setRelationshipLabel(String relationshipLabel)
String	toString()

Methods inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

completeValidation, getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

blockingReferenceBusinessObjectClass

protected Class<?> blockingReferenceBusinessObjectClass

blockedReferencePropertyName

protected String blockedReferencePropertyName

blockedBusinessObjectClass

protected Class<?> blockedBusinessObjectClass

inactivationBlockingDetectionServiceBeanName

protected String inactivationBlockingDetectionServiceBeanName

relationshipLabel

protected String relationshipLabel

businessObjectClass

protected Class<?> businessObjectClass

Constructor Detail

InactivationBlockingDefinition

public InactivationBlockingDefinition()

Method Detail

completeValidation

public void completeValidation(Class<?> rootDataObjectClass,
                      Class<?> otherDataObjectClass,
                      ValidationTrace tracer)

Description copied from class: DataDictionaryDefinitionBase

Empty implementation so that all subclasses do not need to implement this method if they have no local validation to perform.

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class DataDictionaryDefinitionBase

Parameters:

rootDataObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherDataObjectClass - other stuff required to complete validation

tracer - ValidationTrace class used to track what was being validated at the time of any problems discovered

getBlockedReferencePropertyName

@Deprecated
public String getBlockedReferencePropertyName()

Deprecated.

Description copied from interface: InactivationBlockingMetadata

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

Specified by:

getBlockedReferencePropertyName in interface InactivationBlockingMetadata

Returns:

the name of the blocking reference

setBlockedReferencePropertyName

@Deprecated
public void setBlockedReferencePropertyName(String blockedReferencePropertyName)

Deprecated. use setBlockedAttributeName(String) instead

getBlockedAttributeName

public String getBlockedAttributeName()

Description copied from interface: InactivationBlockingMetadata

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

Specified by:

getBlockedAttributeName in interface InactivationBlockingMetadata

Returns:

the name of the blocked attribute

setBlockedAttributeName

public void setBlockedAttributeName(String blockedAttributeName)

getBlockedBusinessObjectClass

@Deprecated
public Class<? extends BusinessObject> getBlockedBusinessObjectClass()

Deprecated.

Description copied from interface: InactivationBlockingMetadata

The type of the object that is blocked.

Specified by:

getBlockedBusinessObjectClass in interface InactivationBlockingMetadata

Returns:

the type of the business object that is blocked

setBlockedBusinessObjectClass

@Deprecated
public void setBlockedBusinessObjectClass(Class<? extends BusinessObject> blockedBusinessObjectClass)

Deprecated. use setBlockedDataObjectClass(Class) instead

getBlockedDataObjectClass

public Class<?> getBlockedDataObjectClass()

Description copied from interface: InactivationBlockingMetadata

Returns the type of the data object that is blocked.

Specified by:

getBlockedDataObjectClass in interface InactivationBlockingMetadata

Returns:

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

setBlockedDataObjectClass

public void setBlockedDataObjectClass(Class<?> blockedDataObjectClass)

getInactivationBlockingDetectionServiceBeanName

public String getInactivationBlockingDetectionServiceBeanName()

Description copied from interface: InactivationBlockingMetadata

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

Specified by:

getInactivationBlockingDetectionServiceBeanName in interface InactivationBlockingMetadata

setInactivationBlockingDetectionServiceBeanName

public void setInactivationBlockingDetectionServiceBeanName(String inactivationBlockingDetectionServiceImpl)

getBlockingReferenceBusinessObjectClass

@Deprecated
public Class<? extends BusinessObject> getBlockingReferenceBusinessObjectClass()

Deprecated.

Description copied from interface: InactivationBlockingMetadata

The type of the object that is blocking another record.

Specified by:

getBlockingReferenceBusinessObjectClass in interface InactivationBlockingMetadata

Returns:

the type of the object that is blocking

setBlockingReferenceBusinessObjectClass

@Deprecated
public void setBlockingReferenceBusinessObjectClass(Class<? extends BusinessObject> blockingReferenceBusinessObjectClass)

Deprecated. use setBlockingReferenceDataObjectClass(Class)

getBlockingDataObjectClass

public Class<?> getBlockingDataObjectClass()

Description copied from interface: InactivationBlockingMetadata

The type of the object that is blocking another record.

Specified by:

getBlockingDataObjectClass in interface InactivationBlockingMetadata

Returns:

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

setBlockingReferenceDataObjectClass

public void setBlockingReferenceDataObjectClass(Class<?> blockingDataObjectClass)

getRelationshipLabel

public String getRelationshipLabel()

Description copied from interface: InactivationBlockingMetadata

Returns the human-meaningful name of the relationship

Specified by:

getRelationshipLabel in interface InactivationBlockingMetadata

Returns:

relationship label

setRelationshipLabel

public void setRelationshipLabel(String relationshipLabel)

getBusinessObjectClass

@Deprecated
public Class<? extends BusinessObject> getBusinessObjectClass()

Deprecated. the businessObjectClass does not appear to be used anywhere significantly internally or externally, no replacement

setBusinessObjectClass

@Deprecated
public void setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass)

Deprecated. the businessObjectClass does not appear to be used anywhere significantly internally or externally, no replacement

toString

public String toString()

Overrides:

toString in class Object