public abstract class DocumentEntry extends DataDictionaryEntryBase
Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process
attributeMap, attributes, collectionMap, collections, complexAttributeMap, complexAttributes, relationshipMap, relationships
Constructor and Description |
---|
DocumentEntry() |
Modifier and Type | Method and Description |
---|---|
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() |
getAttributeDefinition, getAttributeNames, getAttributes, getCollectionDefinition, getCollectionNames, getCollections, getComplexAttributes, getRelationshipDefinition, getRelationshipNames, getRelationships, setAttributes, setCollections, setComplexAttributes, setRelationships
protected String documentTypeName
protected Class<? extends Document> documentClass
protected Class<? extends Document> baseDocumentClass
protected Class<? extends BusinessRule> businessRulesClass
protected boolean allowsNoteAttachments
protected boolean allowsNoteFYI
protected Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass
protected boolean displayTopicFieldInNotes
protected boolean usePessimisticLocking
protected boolean useWorkflowPessimisticLocking
protected boolean encryptDocumentDataInPersistentSessionStorage
protected boolean allowsCopy
protected WorkflowProperties workflowProperties
protected WorkflowAttributes workflowAttributes
protected Class<? extends DocumentAuthorizer> documentAuthorizerClass
protected Class<? extends DocumentPresentationController> documentPresentationControllerClass
protected List<ReferenceDefinition> defaultExistenceChecks
protected Map<String,ReferenceDefinition> defaultExistenceCheckMap
public DocumentEntry()
public String getJstlKey()
DataDictionaryEntry.getJstlKey()
public void setDocumentClass(Class<? extends Document> documentClass)
public Class<? extends Document> getDocumentClass()
public void setBaseDocumentClass(Class<? extends Document> baseDocumentClass)
public Class<? extends Document> getBaseDocumentClass()
public void setBusinessRulesClass(Class<? extends BusinessRule> businessRulesClass)
public Class<? extends BusinessRule> getBusinessRulesClass()
public void setDocumentTypeName(String documentTypeName)
public String getDocumentTypeName()
public void completeValidation()
completeValidation
in interface DataDictionaryEntry
completeValidation
in class DataDictionaryEntryBase
DataDictionaryEntry.completeValidation()
public String getFullClassName()
DataDictionaryEntry
DataDictionaryEntry.getFullClassName()
public Class getEntryClass()
getEntryClass
in class DataDictionaryEntryBase
DataDictionaryEntryBase.getEntryClass()
public boolean getDisplayTopicFieldInNotes()
public void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)
public boolean getUsePessimisticLocking()
public void setUsePessimisticLocking(boolean usePessimisticLocking)
usePessimisticLocking
- public boolean getUseWorkflowPessimisticLocking()
public void setUseWorkflowPessimisticLocking(boolean useWorkflowPessimisticLocking)
useWorkflowPessimisticLocking
- public void setAttachmentTypesValuesFinderClass(Class<? extends KeyValuesFinder> attachmentTypesValuesFinderClass)
public Class<? extends KeyValuesFinder> getAttachmentTypesValuesFinderClass()
org.kuali.rice.krad.datadictionary.control.ControlDefinition#getKeyValuesFinder()
public void setAllowsCopy(boolean allowsCopy)
public boolean getAllowsCopy()
public boolean getAllowsNoteAttachments()
public void setAllowsNoteAttachments(boolean allowsNoteAttachments)
public boolean getAllowsNoteFYI()
public void setAllowsNoteFYI(boolean allowsNoteFYI)
public WorkflowProperties getWorkflowProperties()
public void setWorkflowProperties(WorkflowProperties workflowProperties)
public WorkflowAttributes getWorkflowAttributes()
public void setWorkflowAttributes(WorkflowAttributes workflowAttributes)
public Class<? extends DocumentAuthorizer> getDocumentAuthorizerClass()
DocumentAuthorizer
that will authorize actions for this documentpublic void setDocumentAuthorizerClass(Class<? extends DocumentAuthorizer> documentAuthorizerClass)
documentAuthorizerClass
- public Class<? extends DocumentPresentationController> getDocumentPresentationControllerClass()
DocumentPresentationController
that will be invoked to implement presentation
logic for the documentpublic void setDocumentPresentationControllerClass(Class<? extends DocumentPresentationController> documentPresentationControllerClass)
documentPresentationControllerClass
- public List<ReferenceDefinition> getDefaultExistenceChecks()
public void setDefaultExistenceChecks(List<ReferenceDefinition> defaultExistenceChecks)
public List<String> getDefaultExistenceCheckFieldNames()
public boolean isEncryptDocumentDataInPersistentSessionStorage()
public void setEncryptDocumentDataInPersistentSessionStorage(boolean encryptDocumentDataInPersistentSessionStorage)
public void afterPropertiesSet() throws Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet
in class DataDictionaryEntryBase
Exception
DataDictionaryEntryBase.afterPropertiesSet()
Copyright © 2005–2016 The Kuali Foundation. All rights reserved.