org.kuali.rice.krad.datadictionary

Class MaintenanceDocumentEntry

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryEntryBase

org.kuali.rice.krad.datadictionary.DocumentEntry

org.kuali.rice.krad.datadictionary.MaintenanceDocumentEntry

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DataDictionaryEntry, DictionaryBean

Direct Known Subclasses:

MaintenanceDocumentEntry

public class MaintenanceDocumentEntry
extends DocumentEntry

Data dictionary entry class for MaintenanceDocument

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowsNewOrCopy
protected boolean	allowsRecordDeletion
protected List<String>	clearValueOnCopyPropertyNames
protected Class<?>	dataObjectClass
protected List<String>	lockingKeys
protected Class<? extends Maintainable>	maintainableClass
protected boolean	preserveLockingKeysOnCopy

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

allowsCopy, allowsNoteAttachments, allowsNoteFYI, attachmentTypesValuesFinderClass, baseDocumentClass, businessRulesClass, defaultExistenceCheckMap, defaultExistenceChecks, displayTopicFieldInNotes, documentAuthorizerClass, documentClass, documentPresentationControllerClass, documentTypeName, encryptDocumentDataInPersistentSessionStorage, usePessimisticLocking, useWorkflowPessimisticLocking, workflowAttributes, workflowProperties

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

attributeMap, attributes, collectionMap, collections, complexAttributeMap, complexAttributes, dataObjectMetadata, EXCLUDED_PROPERTY_NAMES, relationshipMap, relationships, stateMapping

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

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
MaintenanceDocumentEntry()

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation(ValidationTrace tracer) Directly validate simple fields, call completeValidation on Definition fields.
boolean	getAllowsNewOrCopy() Gets the allowsNewOrCopy attribute.
boolean	getAllowsRecordDeletion()
List<String>	getClearValueOnCopyPropertyNames()
Class<?>	getDataObjectClass()
Class	getEntryClass()
List<String>	getLockingKeyFieldNames()
List<String>	getLockingKeys()
Class<? extends Maintainable>	getMaintainableClass()
boolean	getPreserveLockingKeysOnCopy()
Class<? extends Document>	getStandardDocumentBaseClass()
void	setAllowsNewOrCopy(boolean allowsNewOrCopy) The allowsNewOrCopy element contains a value of true or false.
void	setAllowsRecordDeletion(boolean allowsRecordDeletion)
void	setClearValueOnCopyPropertyNames(List<String> clearValueOnCopyPropertyNames)
void	setDataObjectClass(Class<?> dataObjectClass)
void	setLockingKeys(List<String> lockingKeys)
void	setMaintainableClass(Class<? extends Maintainable> maintainableClass)
void	setPreserveLockingKeysOnCopy(boolean preserveLockingKeysOnCopy)
protected void	validateDefaultExistenceChecks(ValidationTrace tracer)

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

dataDictionaryPostProcessing, getAllowsCopy, getAllowsNoteAttachments, getAllowsNoteFYI, getAttachmentTypesValuesFinderClass, getBaseDocumentClass, getBusinessRulesClass, getDefaultExistenceCheckFieldNames, getDefaultExistenceChecks, getDisplayTopicFieldInNotes, getDocumentAuthorizerClass, getDocumentClass, getDocumentPresentationControllerClass, getDocumentTypeName, getFullClassName, getJstlKey, getUsePessimisticLocking, getUseWorkflowPessimisticLocking, getWorkflowAttributes, getWorkflowProperties, isEncryptDocumentDataInPersistentSessionStorage, setAllowsCopy, setAllowsNoteAttachments, setAllowsNoteFYI, setAttachmentTypesValuesFinderClass, setBaseDocumentClass, setBusinessRulesClass, setDefaultExistenceChecks, setDisplayTopicFieldInNotes, setDocumentAuthorizerClass, setDocumentClass, setDocumentPresentationControllerClass, setDocumentTypeName, setEncryptDocumentDataInPersistentSessionStorage, setUsePessimisticLocking, setUseWorkflowPessimisticLocking, setWorkflowAttributes, setWorkflowProperties

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

completeValidation, embedMetadata, getAttributeDefinition, getAttributeNames, getAttributes, getCollectionDefinition, getCollectionNames, getCollections, getComplexAttributes, getDataObjectMetadata, getRelationshipDefinition, getRelationshipMap, getRelationshipNames, getRelationships, getStateMapping, hasEmbeddedDataObjectMetadata, hasExcludedHint, injectMetadataIntoAttributes, injectMetadataIntoCollections, injectMetadataIntoRelationships, setAttributes, setCollections, setComplexAttributes, setDataObjectMetadata, setRelationshipMap, setRelationships, setStateMapping

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

clone, copy, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

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

getComponentCode, getNamespaceCode

Field Detail

dataObjectClass

protected Class<?> dataObjectClass

maintainableClass

protected Class<? extends Maintainable> maintainableClass

lockingKeys

protected List<String> lockingKeys

clearValueOnCopyPropertyNames

protected List<String> clearValueOnCopyPropertyNames

allowsNewOrCopy

protected boolean allowsNewOrCopy

preserveLockingKeysOnCopy

protected boolean preserveLockingKeysOnCopy

allowsRecordDeletion

protected boolean allowsRecordDeletion

Constructor Detail

MaintenanceDocumentEntry

public MaintenanceDocumentEntry()

Method Detail

getStandardDocumentBaseClass

public Class<? extends Document> getStandardDocumentBaseClass()

setDataObjectClass

public void setDataObjectClass(Class<?> dataObjectClass)

getDataObjectClass

public Class<?> getDataObjectClass()

getEntryClass

public Class getEntryClass()

Overrides:

getEntryClass in class DocumentEntry

See Also:

DocumentEntry.getEntryClass()

setMaintainableClass

public void setMaintainableClass(Class<? extends Maintainable> maintainableClass)

getMaintainableClass

public Class<? extends Maintainable> getMaintainableClass()

getLockingKeyFieldNames

public List<String> getLockingKeyFieldNames()

Returns:

List of all lockingKey fieldNames associated with this LookupDefinition, in the order in which they were added

getAllowsNewOrCopy

public boolean getAllowsNewOrCopy()

Gets the allowsNewOrCopy attribute.

Returns:

Returns the allowsNewOrCopy.

setAllowsNewOrCopy

public void setAllowsNewOrCopy(boolean allowsNewOrCopy)

The allowsNewOrCopy element contains a value of true or false. If true, this indicates the maintainable should allow the new and/or copy maintenance actions.

completeValidation

public void completeValidation(ValidationTrace tracer)

Directly validate simple fields, call completeValidation on Definition fields.

Specified by:

completeValidation in interface DataDictionaryEntry

Overrides:

completeValidation in class DocumentEntry

Parameters:

tracer - - Record of object's location

See Also:

DataDictionaryEntryBase.completeValidation()

validateDefaultExistenceChecks

protected void validateDefaultExistenceChecks(ValidationTrace tracer)

Overrides:

validateDefaultExistenceChecks in class DocumentEntry

getLockingKeys

public List<String> getLockingKeys()

setLockingKeys

public void setLockingKeys(List<String> lockingKeys)

getPreserveLockingKeysOnCopy

public boolean getPreserveLockingKeysOnCopy()

Returns:

the preserveLockingKeysOnCopy

setPreserveLockingKeysOnCopy

public void setPreserveLockingKeysOnCopy(boolean preserveLockingKeysOnCopy)

Parameters:

preserveLockingKeysOnCopy - the preserveLockingKeysOnCopy to set

getClearValueOnCopyPropertyNames

public List<String> getClearValueOnCopyPropertyNames()

Returns:

the clearValueOnCopyPropertyNames

setClearValueOnCopyPropertyNames

public void setClearValueOnCopyPropertyNames(List<String> clearValueOnCopyPropertyNames)

Parameters:

clearValueOnCopyPropertyNames - the clearValueOnCopyPropertyNames to set

getAllowsRecordDeletion

public boolean getAllowsRecordDeletion()

Returns:

the allowRecordDeletion

setAllowsRecordDeletion

public void setAllowsRecordDeletion(boolean allowsRecordDeletion)

Parameters:

allowsRecordDeletion - the allowRecordDeletion to set