org.kuali.rice.krad.datadictionary
Class DocumentEntry

java.lang.Object
  org.kuali.rice.krad.datadictionary.DataDictionaryEntryBase
      org.kuali.rice.krad.datadictionary.DocumentEntry

All Implemented Interfaces:

Serializable, DataDictionaryEntry, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

MaintenanceDocumentEntry, TransactionalDocumentEntry

public abstract class DocumentEntry
extends DataDictionaryEntryBase

A single Document entry in the DataDictionary, which contains information relating to the display, validation, and general maintenance of a Document (transactional or maintenance) and its attributes

Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process

Author:

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

See Also:

Serialized Form

Field Summary

protected boolean	allowsCopy
protected boolean	allowsNoteAttachments
protected boolean	allowsNoteFYI
protected Class<? extends KeyValuesFinder>	attachmentTypesValuesFinderClass
protected Class<? extends Document>	baseDocumentClass
protected Class<? extends BusinessRule>	businessRulesClass
protected Map<String,ReferenceDefinition>	defaultExistenceCheckMap
protected List<ReferenceDefinition>	defaultExistenceChecks
protected boolean	displayTopicFieldInNotes
protected Class<? extends DocumentAuthorizer>	documentAuthorizerClass
protected Class<? extends Document>	documentClass
protected Class<? extends DocumentPresentationController>	documentPresentationControllerClass
protected String	documentTypeName
protected boolean	encryptDocumentDataInPersistentSessionStorage
protected boolean	usePessimisticLocking
protected boolean	useWorkflowPessimisticLocking
protected WorkflowAttributes	workflowAttributes
protected WorkflowProperties	workflowProperties

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

attributeMap, attributes, collectionMap, collections, complexAttributeMap, complexAttributes, relationshipMap, relationships

Constructor Summary

DocumentEntry()

Method Summary

void	afterPropertiesSet() This overridden method ...
void	completeValidation() Validate common fields for subclass' benefit.
boolean	getAllowsCopy()
boolean	getAllowsNoteAttachments()
boolean	getAllowsNoteFYI()
Class<? extends KeyValuesFinder>	getAttachmentTypesValuesFinderClass()
Class<? extends Document>	getBaseDocumentClass()
Class<? extends BusinessRule>	getBusinessRulesClass()
List<String>	getDefaultExistenceCheckFieldNames()
List<ReferenceDefinition>	getDefaultExistenceChecks()
boolean	getDisplayTopicFieldInNotes() Accessor method for contained displayTopicFieldInNotes
Class<? extends DocumentAuthorizer>	getDocumentAuthorizerClass() Full class name for the DocumentAuthorizer that will authorize actions for this document
Class<? extends Document>	getDocumentClass()
Class<? extends DocumentPresentationController>	getDocumentPresentationControllerClass() Full class name for the DocumentPresentationController that will be invoked to implement presentation logic for the document
String	getDocumentTypeName()
Class	getEntryClass()
String	getFullClassName() Returns the full class name of the underlying object.
String	getJstlKey()
boolean	getUsePessimisticLocking() Accessor method for contained usePessimisticLocking
boolean	getUseWorkflowPessimisticLocking() Accessor method for contained useWorkflowPessimisticLocking
WorkflowAttributes	getWorkflowAttributes()
WorkflowProperties	getWorkflowProperties()
boolean	isEncryptDocumentDataInPersistentSessionStorage()
void	setAllowsCopy(boolean allowsCopy) The allowsCopy element contains a true or false value.
void	setAllowsNoteAttachments(boolean allowsNoteAttachments) The allowsNoteAttachments element contains a true or false value.
void	setAllowsNoteFYI(boolean allowsNoteFYI) This is an indicator for determining whether to render the AdHoc FYI recipient box and Send FYI button.
void	setAttachmentTypesValuesFinderClass(Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass) The attachmentTypesValuesFinderClass specifies the name of a values finder class.
void	setBaseDocumentClass(Class<? extends Document> baseDocumentClass) The optional baseDocumentClass element is the name of the java base class associated with the document.
void	setBusinessRulesClass(Class<? extends BusinessRule> businessRulesClass) The businessRulesClass element is the full class name of the java class which contains the business rules for a document.
void	setDefaultExistenceChecks(List<ReferenceDefinition> defaultExistenceChecks)
void	setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes) This field contains a value of true or false.
void	setDocumentAuthorizerClass(Class<? extends DocumentAuthorizer> documentAuthorizerClass) Setter for the document authorizer class name
void	setDocumentClass(Class<? extends Document> documentClass) The documentClass element is the name of the java class associated with the document.
void	setDocumentPresentationControllerClass(Class<? extends DocumentPresentationController> documentPresentationControllerClass) Setter for the document presentation controller class name
void	setDocumentTypeName(String documentTypeName) The documentTypeName element is the name of the document as defined in the workflow system.
void	setEncryptDocumentDataInPersistentSessionStorage(boolean encryptDocumentDataInPersistentSessionStorage)
void	setUsePessimisticLocking(boolean usePessimisticLocking)
void	setUseWorkflowPessimisticLocking(boolean useWorkflowPessimisticLocking)
void	setWorkflowAttributes(WorkflowAttributes workflowAttributes)
void	setWorkflowProperties(WorkflowProperties workflowProperties) This element is used to define a set of workflowPropertyGroups, which are used to specify which document properties should be serialized during the document serialization process.
String	toString()

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

getAttributeDefinition, getAttributeNames, getAttributes, getCollectionDefinition, getCollectionNames, getCollections, getComplexAttributes, getRelationshipDefinition, getRelationshipNames, getRelationships, setAttributes, setCollections, setComplexAttributes, setRelationships

Methods inherited from class java.lang.Object

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

Field Detail

documentTypeName

protected String documentTypeName

documentClass

protected Class<? extends Document> documentClass

baseDocumentClass

protected Class<? extends Document> baseDocumentClass

businessRulesClass

protected Class<? extends BusinessRule> businessRulesClass

allowsNoteAttachments

protected boolean allowsNoteAttachments

allowsNoteFYI

protected boolean allowsNoteFYI

attachmentTypesValuesFinderClass

protected Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass

displayTopicFieldInNotes

protected boolean displayTopicFieldInNotes

usePessimisticLocking

protected boolean usePessimisticLocking

useWorkflowPessimisticLocking

protected boolean useWorkflowPessimisticLocking

encryptDocumentDataInPersistentSessionStorage

protected boolean encryptDocumentDataInPersistentSessionStorage

allowsCopy

protected boolean allowsCopy

workflowProperties

protected WorkflowProperties workflowProperties

workflowAttributes

protected WorkflowAttributes workflowAttributes

documentAuthorizerClass

protected Class<? extends DocumentAuthorizer> documentAuthorizerClass

documentPresentationControllerClass

protected Class<? extends DocumentPresentationController> documentPresentationControllerClass

defaultExistenceChecks

protected List<ReferenceDefinition> defaultExistenceChecks

defaultExistenceCheckMap

protected Map<String,ReferenceDefinition> defaultExistenceCheckMap

Constructor Detail

DocumentEntry

public DocumentEntry()

Method Detail

getJstlKey

public String getJstlKey()

Returns:

String used as a globally-unique key for this entry's jstl-exported version

See Also:

DataDictionaryEntry.getJstlKey()

setDocumentClass

public void setDocumentClass(Class<? extends Document> documentClass)

The documentClass element is the name of the java class associated with the document.

getDocumentClass

public Class<? extends Document> getDocumentClass()

setBaseDocumentClass

public void setBaseDocumentClass(Class<? extends Document> baseDocumentClass)

The optional baseDocumentClass element is the name of the java base class associated with the document. This gives the data dictionary the ability to index by the base class in addition to the current class.

getBaseDocumentClass

public Class<? extends Document> getBaseDocumentClass()

setBusinessRulesClass

public void setBusinessRulesClass(Class<? extends BusinessRule> businessRulesClass)

The businessRulesClass element is the full class name of the java class which contains the business rules for a document.

getBusinessRulesClass

public Class<? extends BusinessRule> getBusinessRulesClass()

setDocumentTypeName

public void setDocumentTypeName(String documentTypeName)

The documentTypeName element is the name of the document as defined in the workflow system. Example: "AddressTypeMaintenanceDocument"

getDocumentTypeName

public String getDocumentTypeName()

completeValidation

public void completeValidation()

Validate common fields for subclass' benefit.

Specified by:

completeValidation in interface DataDictionaryEntry

Overrides:

completeValidation in class DataDictionaryEntryBase

See Also:

DataDictionaryEntry.completeValidation()

getFullClassName

public String getFullClassName()

Description copied from interface: DataDictionaryEntry

Returns the full class name of the underlying object.

See Also:

DataDictionaryEntry.getFullClassName()

getEntryClass

public Class getEntryClass()

Specified by:

getEntryClass in class DataDictionaryEntryBase

See Also:

DataDictionaryEntryBase.getEntryClass()

toString

public String toString()

Overrides:

toString in class Object

getDisplayTopicFieldInNotes

public boolean getDisplayTopicFieldInNotes()

Accessor method for contained displayTopicFieldInNotes

Returns:

displayTopicFieldInNotes boolean

setDisplayTopicFieldInNotes

public void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)

This field contains a value of true or false. If true, then the "Notes and Attachments" tab will render a column for a note topic.

getUsePessimisticLocking

public boolean getUsePessimisticLocking()

Accessor method for contained usePessimisticLocking

Returns:

usePessimisticLocking boolean

setUsePessimisticLocking

public void setUsePessimisticLocking(boolean usePessimisticLocking)

Parameters:

usePessimisticLocking -

getUseWorkflowPessimisticLocking

public boolean getUseWorkflowPessimisticLocking()

Accessor method for contained useWorkflowPessimisticLocking

Returns:

useWorkflowPessimisticLocking boolean

setUseWorkflowPessimisticLocking

public void setUseWorkflowPessimisticLocking(boolean useWorkflowPessimisticLocking)

Parameters:

useWorkflowPessimisticLocking -

setAttachmentTypesValuesFinderClass

public void setAttachmentTypesValuesFinderClass(Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass)

The attachmentTypesValuesFinderClass specifies the name of a values finder class. This is used to determine the set of file types that are allowed to be attached to the document.

getAttachmentTypesValuesFinderClass

public Class<? extends KeyValuesFinder> getAttachmentTypesValuesFinderClass()

See Also:

org.kuali.rice.krad.datadictionary.control.ControlDefinition#getKeyValuesFinder()

setAllowsCopy

public void setAllowsCopy(boolean allowsCopy)

The allowsCopy element contains a true or false value. If true, then a user is allowed to make a copy of the record using the maintenance screen.

getAllowsCopy

public boolean getAllowsCopy()

getAllowsNoteAttachments

public boolean getAllowsNoteAttachments()

Returns:

the allowsNoteAttachments

setAllowsNoteAttachments

public void setAllowsNoteAttachments(boolean allowsNoteAttachments)

The allowsNoteAttachments element contains a true or false value. If true, then a document screen includes notes with attachments. Otherwise, only notes is displayed.

getAllowsNoteFYI

public boolean getAllowsNoteFYI()

Returns:

the allowsNoteFYI

setAllowsNoteFYI

public void setAllowsNoteFYI(boolean allowsNoteFYI)

This is an indicator for determining whether to render the AdHoc FYI recipient box and Send FYI button.

getWorkflowProperties

public WorkflowProperties getWorkflowProperties()

setWorkflowProperties

public void setWorkflowProperties(WorkflowProperties workflowProperties)

This element is used to define a set of workflowPropertyGroups, which are used to specify which document properties should be serialized during the document serialization process.

getWorkflowAttributes

public WorkflowAttributes getWorkflowAttributes()

setWorkflowAttributes

public void setWorkflowAttributes(WorkflowAttributes workflowAttributes)

getDocumentAuthorizerClass

public Class<? extends DocumentAuthorizer> getDocumentAuthorizerClass()

Full class name for the DocumentAuthorizer that will authorize actions for this document

Returns:

class name for document authorizer

setDocumentAuthorizerClass

public void setDocumentAuthorizerClass(Class<? extends DocumentAuthorizer> documentAuthorizerClass)

Setter for the document authorizer class name

Parameters:

documentAuthorizerClass -

getDocumentPresentationControllerClass

public Class<? extends DocumentPresentationController> getDocumentPresentationControllerClass()

Full class name for the DocumentPresentationController that will be invoked to implement presentation logic for the document

Returns:

class name for document presentation controller

setDocumentPresentationControllerClass

public void setDocumentPresentationControllerClass(Class<? extends DocumentPresentationController> documentPresentationControllerClass)

Setter for the document presentation controller class name

Parameters:

documentPresentationControllerClass -

getDefaultExistenceChecks

public List<ReferenceDefinition> getDefaultExistenceChecks()

Returns:

List of all defaultExistenceCheck ReferenceDefinitions associated with this MaintenanceDocument, in the order in which they were added

setDefaultExistenceChecks

public void setDefaultExistenceChecks(List<ReferenceDefinition> defaultExistenceChecks)

getDefaultExistenceCheckFieldNames

public List<String> getDefaultExistenceCheckFieldNames()

Returns:

List of all defaultExistenceCheck reference fieldNames associated with this MaintenanceDocument, in the order in which they were added

isEncryptDocumentDataInPersistentSessionStorage

public boolean isEncryptDocumentDataInPersistentSessionStorage()

setEncryptDocumentDataInPersistentSessionStorage

public void setEncryptDocumentDataInPersistentSessionStorage(boolean encryptDocumentDataInPersistentSessionStorage)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

This overridden method ...

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class DataDictionaryEntryBase

Throws:

Exception

See Also:

DataDictionaryEntryBase.afterPropertiesSet()