Package org.kuali.rice.krad.datadictionary

Class DocumentEntry

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryEntryBase
org.kuali.rice.krad.datadictionary.DocumentEntry
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DataDictionaryEntry, DictionaryBean
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

The setters do validation to facilitate generating errors during the parsing process.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Field Details

    • 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 Details

    • DocumentEntry

      public DocumentEntry()

  • Method Details

    • getJstlKey

      public String getJstlKey()
      Returns:
      String used as a globally-unique key for this entry's jstl-exported version
      See Also:

    • setDocumentClass

      public void setDocumentClass(Class<? extends Document> documentClass)
      Setter for document class associated with the document
      Parameters:
      documentClass - - the document class associated with the document

    • getDocumentClass

      public Class<? extends Document> getDocumentClass()
      The Document subclass associated with the document
      Returns:
      Classinvalid input: '<'? extends Document>

    • 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.
      Parameters:
      baseDocumentClass - - the superclass associated with the document

    • getBaseDocumentClass

      public Class<? extends Document> getBaseDocumentClass()
      The optional Document superclass associated with the document

      This gives the data dictionary the ability to index by the superclass in addition to the current class.

      Returns:
      Classinvalid input: '<'? extends Document>

    • setBusinessRulesClass

      public void setBusinessRulesClass(Class<? extends BusinessRule> businessRulesClass)
      Setter for the BusinessRule to execute rules for the document

    • getBusinessRulesClass

      public Class<? extends BusinessRule> getBusinessRulesClass()
      The BusinessRule that will be used to execute business rules for the document
      Returns:
      BusinessRule

    • setDocumentTypeName

      public void setDocumentTypeName(String documentTypeName)
      Setter for the name of the document as defined in the workflow system
      Parameters:
      documentTypeName - - name of the document in workflow

    • getDocumentTypeName

      public String getDocumentTypeName()
      The name of the document in the workflow system
      Returns:
      String

    • dataDictionaryPostProcessing

      public void dataDictionaryPostProcessing()
      Description copied from interface: DictionaryBean
      Perform any needed post-processing of the bean properties. This will be called starting at the parent data object entry or document entry class and recursed down though all other DictionaryBean objects contained within.
      Specified by:
      dataDictionaryPostProcessing in interface DictionaryBean
      Overrides:
      dataDictionaryPostProcessing in class DataDictionaryEntryBase

    • completeValidation

      public void completeValidation(ValidationTrace tracer)
      Description copied from class: DataDictionaryEntryBase
      Directly validate simple fields, call completeValidation on Definition fields.
      Specified by:
      completeValidation in interface DataDictionaryEntry
      Overrides:
      completeValidation in class DataDictionaryEntryBase
      Parameters:
      tracer - - Record of object's location
      See Also:

    • validateDefaultExistenceChecks

      protected void validateDefaultExistenceChecks(ValidationTrace tracer)

    • getFullClassName

      public String getFullClassName()
      Description copied from interface: DataDictionaryEntry
      Returns the full class name of the underlying object.
      See Also:

    • getEntryClass

      public Class getEntryClass()
      Specified by:
      getEntryClass in class DataDictionaryEntryBase
      See Also:

    • getDisplayTopicFieldInNotes

      public boolean getDisplayTopicFieldInNotes()
      Indicates whether the "Notes and Attachments" tab will render a column for a note topic
      Returns:
      boolean

    • setDisplayTopicFieldInNotes

      public void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)
      Setter for the flag indicating whether the note topic field will be rendered in the notes tab
      Parameters:
      displayTopicFieldInNotes -

    • getUsePessimisticLocking

      public boolean getUsePessimisticLocking()
      DataObjectWrapper method for contained usePessimisticLocking
      Returns:
      usePessimisticLocking boolean

    • setUsePessimisticLocking

      public void setUsePessimisticLocking(boolean usePessimisticLocking)
      Parameters:
      usePessimisticLocking -

    • getUseWorkflowPessimisticLocking

      public boolean getUseWorkflowPessimisticLocking()
      DataObjectWrapper 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:

    • 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()
      Indicates that a document screen allows notes with attachments

      The add attachments section on notes will not be rendered when this is set to false.

      Returns:
      boolean

    • setAllowsNoteAttachments

      public void setAllowsNoteAttachments(boolean allowsNoteAttachments)
      Setter for flag indicating that attacments can be added to notes
      Parameters:
      allowsNoteAttachments -

    • getAllowsNoteFYI

      public boolean getAllowsNoteFYI()
      Indicates whether to render the AdHoc FYI recipient box and Send FYI button
      Returns:
      boolean

    • setAllowsNoteFYI

      public void setAllowsNoteFYI(boolean allowsNoteFYI)
      Setter for the flag indicating whether to render the AdHoc FYI recipient box and Send FYI button
      Parameters:
      allowsNoteFYI -

    • 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()
      The defaultExistenceChecks element contains a list of reference object names which are required to exist when maintaining a BO

      Optionally, the reference objects can be required to be active. The list keeps the order in which they were added. JSTL: defaultExistenceChecks is a Map of Reference elements, whose entries are keyed by attributeName.

      Returns:
      list of reference definitions

    • setDefaultExistenceChecks

      public void setDefaultExistenceChecks(List<ReferenceDefinition> defaultExistenceChecks)
      Setter for the list of all defaultExistenceCheck ReferenceDefinition associated with this MaintenanceDocument
      Parameters:
      defaultExistenceChecks -

    • getDefaultExistenceCheckFieldNames

      public List<String> getDefaultExistenceCheckFieldNames()
      The List of all defaultExistenceCheck reference fieldNames associated with this MaintenanceDocument

      The List keeps the order the items were added in.

      Returns:
      List

    • isEncryptDocumentDataInPersistentSessionStorage

      public boolean isEncryptDocumentDataInPersistentSessionStorage()
      Indicates that the document data should be encrypted when persisted
      Returns:
      boolean

    • setEncryptDocumentDataInPersistentSessionStorage

      public void setEncryptDocumentDataInPersistentSessionStorage(boolean encryptDocumentDataInPersistentSessionStorage)
      Setter for flag indicating that the document data should be encrypted when persisted
      Parameters:
      encryptDocumentDataInPersistentSessionStorage -