org.kuali.rice.kns.datadictionary
Class MaintenanceDocumentEntry

java.lang.Object
  extended by org.kuali.rice.krad.datadictionary.DataDictionaryEntryBase
      extended by org.kuali.rice.krad.datadictionary.DocumentEntry
          extended by org.kuali.rice.krad.datadictionary.MaintenanceDocumentEntry
              extended by org.kuali.rice.kns.datadictionary.MaintenanceDocumentEntry
All Implemented Interfaces:
Serializable, KNSDocumentEntry, DataDictionaryEntry, org.springframework.beans.factory.InitializingBean

Deprecated.

@Deprecated
public class MaintenanceDocumentEntry
extends MaintenanceDocumentEntry
implements KNSDocumentEntry

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

Field Summary
protected  String additionalSectionsFile
          Deprecated.  
protected  boolean allowsNewOrCopy
          Deprecated.  
protected  boolean allowsRecordDeletion
          Deprecated.  
protected  Class<? extends DerivedValuesSetter> derivedValuesSetterClass
          Deprecated.  
protected  List<HeaderNavigation> headerNavigationList
          Deprecated.  
protected  List<String> lockingKeys
          Deprecated.  
protected  Map<String,MaintainableSectionDefinition> maintainableSectionMap
          Deprecated.  
protected  List<MaintainableSectionDefinition> maintainableSections
          Deprecated.  
protected  boolean preserveLockingKeysOnCopy
          Deprecated.  
protected  Class<? extends PromptBeforeValidation> promptBeforeValidationClass
          Deprecated.  
protected  boolean sessionDocument
          Deprecated.  
protected  boolean translateCodes
          Deprecated.  
protected  List<String> webScriptFiles
          Deprecated.  
 
Fields inherited from class org.kuali.rice.krad.datadictionary.MaintenanceDocumentEntry
dataObjectClass, maintainableClass
 
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, relationshipMap, relationships, stateMapping
 
Constructor Summary
MaintenanceDocumentEntry()
          Deprecated.  
 
Method Summary
 void completeValidation()
          Deprecated. Directly validate simple fields, call completeValidation on Definition fields.
 String getAdditionalSectionsFile()
          Deprecated. 
 boolean getAllowsNewOrCopy()
          Deprecated. Gets the allowsNewOrCopy attribute.
 boolean getAllowsRecordDeletion()
          Deprecated.  
 Class<? extends BusinessObject> getBusinessObjectClass()
          Deprecated.  
 Class<? extends DerivedValuesSetter> getDerivedValuesSetterClass()
          Deprecated.  
 Class<? extends DocumentAuthorizer> getDocumentAuthorizerClass()
          Deprecated. Returns the document authorizer class for the document.
 Class<? extends DocumentPresentationController> getDocumentPresentationControllerClass()
          Deprecated. Returns the document presentation controller class for the document.
 Class getEntryClass()
          Deprecated.  
 List<HeaderNavigation> getHeaderNavigationList()
          Deprecated.  
 List<String> getLockingKeyFieldNames()
          Deprecated.  
 List<String> getLockingKeys()
          Deprecated.  
 Class<? extends Maintainable> getMaintainableClass()
          Deprecated.  
 List<MaintainableSectionDefinition> getMaintainableSections()
          Deprecated.  
 boolean getPreserveLockingKeysOnCopy()
          Deprecated.  
 Class<? extends PromptBeforeValidation> getPromptBeforeValidationClass()
          Deprecated.  
 Class<? extends Document> getStandardDocumentBaseClass()
          Deprecated.  
 List<String> getWebScriptFiles()
          Deprecated.  
 boolean isSessionDocument()
          Deprecated.  
 boolean isTranslateCodes()
          Deprecated. 
 void setAdditionalSectionsFile(String additionalSectionsFile)
          Deprecated. 
 void setAllowsNewOrCopy(boolean allowsNewOrCopy)
          Deprecated. The allowsNewOrCopy element contains a value of true or false.
 void setAllowsRecordDeletion(boolean allowsRecordDeletion)
          Deprecated.  
 void setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass)
          Deprecated.  
 void setDerivedValuesSetterClass(Class<? extends DerivedValuesSetter> derivedValuesSetter)
          Deprecated.  
 void setHeaderNavigationList(List<HeaderNavigation> headerNavigationList)
          Deprecated. The headerNavigation element defines a set of additional tabs which will appear on the document.
 void setLockingKeys(List<String> lockingKeys)
          Deprecated.  
 void setMaintainableSections(List<MaintainableSectionDefinition> maintainableSections)
          Deprecated. 
 void setPreserveLockingKeysOnCopy(boolean preserveLockingKeysOnCopy)
          Deprecated.  
 void setPromptBeforeValidationClass(Class<? extends PromptBeforeValidation> preRulesCheckClass)
          Deprecated. The promptBeforeValidationClass element is the full class name of the java class which determines whether the user should be asked any questions prior to running validation.
 void setSessionDocument(boolean sessionDocument)
          Deprecated.  
 void setTranslateCodes(boolean translateCodes)
          Deprecated. 
 void setWebScriptFiles(List<String> webScriptFiles)
          Deprecated. The webScriptFile element defines the name of javascript files that are necessary for processing the document.
 String toString()
          Deprecated.  
 
Methods inherited from class org.kuali.rice.krad.datadictionary.MaintenanceDocumentEntry
getDataObjectClass, setDataObjectClass, setMaintainableClass
 
Methods inherited from class org.kuali.rice.krad.datadictionary.DocumentEntry
afterPropertiesSet, getAllowsCopy, getAllowsNoteAttachments, getAllowsNoteFYI, getAttachmentTypesValuesFinderClass, getBaseDocumentClass, getBusinessRulesClass, getDefaultExistenceCheckFieldNames, getDefaultExistenceChecks, getDisplayTopicFieldInNotes, getDocumentClass, 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
getAttributeDefinition, getAttributeNames, getAttributes, getCollectionDefinition, getCollectionNames, getCollections, getComplexAttributes, getRelationshipDefinition, getRelationshipNames, getRelationships, getStateMapping, setAttributes, setCollections, setComplexAttributes, setRelationships, setStateMapping
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.kns.datadictionary.KNSDocumentEntry
getAllowsCopy, getAllowsNoteAttachments, getAllowsNoteFYI, getAttachmentTypesValuesFinderClass, getBaseDocumentClass, getBusinessRulesClass, getDefaultExistenceChecks, getDisplayTopicFieldInNotes, getDocumentClass, getDocumentTypeName, getUsePessimisticLocking, getUseWorkflowPessimisticLocking, getWorkflowAttributes, getWorkflowProperties, isEncryptDocumentDataInPersistentSessionStorage, setAllowsCopy, setAllowsNoteAttachments, setAllowsNoteFYI, setAttachmentTypesValuesFinderClass, setBaseDocumentClass, setBusinessRulesClass, setDefaultExistenceChecks, setDisplayTopicFieldInNotes, setDocumentClass, setDocumentTypeName, setEncryptDocumentDataInPersistentSessionStorage, setUsePessimisticLocking, setUseWorkflowPessimisticLocking, setWorkflowAttributes, setWorkflowProperties
 
Methods inherited from interface org.kuali.rice.krad.datadictionary.DataDictionaryEntry
getAttributeDefinition, getFullClassName, getJstlKey, getRelationships, getStateMapping, setStateMapping
 
Methods inherited from interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet
 

Field Detail

maintainableSections

protected List<MaintainableSectionDefinition> maintainableSections
Deprecated. 

lockingKeys

protected List<String> lockingKeys
Deprecated. 

maintainableSectionMap

protected Map<String,MaintainableSectionDefinition> maintainableSectionMap
Deprecated. 

allowsNewOrCopy

protected boolean allowsNewOrCopy
Deprecated. 

additionalSectionsFile

protected String additionalSectionsFile
Deprecated. 

preserveLockingKeysOnCopy

protected boolean preserveLockingKeysOnCopy
Deprecated. 

allowsRecordDeletion

protected boolean allowsRecordDeletion
Deprecated. 

translateCodes

protected boolean translateCodes
Deprecated. 

promptBeforeValidationClass

protected Class<? extends PromptBeforeValidation> promptBeforeValidationClass
Deprecated. 

derivedValuesSetterClass

protected Class<? extends DerivedValuesSetter> derivedValuesSetterClass
Deprecated. 

webScriptFiles

protected List<String> webScriptFiles
Deprecated. 

headerNavigationList

protected List<HeaderNavigation> headerNavigationList
Deprecated. 

sessionDocument

protected boolean sessionDocument
Deprecated. 
Constructor Detail

MaintenanceDocumentEntry

public MaintenanceDocumentEntry()
Deprecated. 
Method Detail

getPromptBeforeValidationClass

public Class<? extends PromptBeforeValidation> getPromptBeforeValidationClass()
Deprecated. 
Specified by:
getPromptBeforeValidationClass in interface KNSDocumentEntry
Returns:
Returns the preRulesCheckClass.

setPromptBeforeValidationClass

public void setPromptBeforeValidationClass(Class<? extends PromptBeforeValidation> preRulesCheckClass)
Deprecated. 
The promptBeforeValidationClass element is the full class name of the java class which determines whether the user should be asked any questions prior to running validation.

Specified by:
setPromptBeforeValidationClass in interface KNSDocumentEntry
See Also:
KualiDocumentActionBase#promptBeforeValidation(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, String)

getStandardDocumentBaseClass

public Class<? extends Document> getStandardDocumentBaseClass()
Deprecated. 
Overrides:
getStandardDocumentBaseClass in class MaintenanceDocumentEntry

setBusinessObjectClass

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

getBusinessObjectClass

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

getEntryClass

public Class getEntryClass()
Deprecated. 
Overrides:
getEntryClass in class MaintenanceDocumentEntry
See Also:
DocumentEntry.getEntryClass()

getMaintainableClass

public Class<? extends Maintainable> getMaintainableClass()
Deprecated. 
Overrides:
getMaintainableClass in class MaintenanceDocumentEntry

getMaintainableSections

public List<MaintainableSectionDefinition> getMaintainableSections()
Deprecated. 
Returns:
List of MaintainableSectionDefinition objects contained in this document

getLockingKeyFieldNames

public List<String> getLockingKeyFieldNames()
Deprecated. 
Overrides:
getLockingKeyFieldNames in class MaintenanceDocumentEntry
Returns:
List of all lockingKey fieldNames associated with this LookupDefinition, in the order in which they were added

getAllowsNewOrCopy

public boolean getAllowsNewOrCopy()
Deprecated. 
Gets the allowsNewOrCopy attribute.

Overrides:
getAllowsNewOrCopy in class MaintenanceDocumentEntry
Returns:
Returns the allowsNewOrCopy.

setAllowsNewOrCopy

public void setAllowsNewOrCopy(boolean allowsNewOrCopy)
Deprecated. 
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.

Overrides:
setAllowsNewOrCopy in class MaintenanceDocumentEntry

completeValidation

public void completeValidation()
Deprecated. 
Directly validate simple fields, call completeValidation on Definition fields.

Specified by:
completeValidation in interface DataDictionaryEntry
Overrides:
completeValidation in class MaintenanceDocumentEntry
See Also:
DocumentEntry.completeValidation()

toString

public String toString()
Deprecated. 
Overrides:
toString in class MaintenanceDocumentEntry
See Also:
Object.toString()

getAdditionalSectionsFile

@Deprecated
public String getAdditionalSectionsFile()
Deprecated. 


setAdditionalSectionsFile

@Deprecated
public void setAdditionalSectionsFile(String additionalSectionsFile)
Deprecated. 


getLockingKeys

public List<String> getLockingKeys()
Deprecated. 
Overrides:
getLockingKeys in class MaintenanceDocumentEntry

setLockingKeys

public void setLockingKeys(List<String> lockingKeys)
Deprecated. 
Overrides:
setLockingKeys in class MaintenanceDocumentEntry

setMaintainableSections

@Deprecated
public void setMaintainableSections(List<MaintainableSectionDefinition> maintainableSections)
Deprecated. 

The maintainableSections elements allows the maintenance document to be presented in sections. Each section can have a different title. JSTL: maintainbleSections is a Map whichis accessed by a key of "maintainableSections". This map contains entries with the following keys: "0" (for first section) "1" (for second section) etc. The corresponding value for each entry is a maintainableSection ExportMap. See MaintenanceDocumentEntryMapper.java.


getPreserveLockingKeysOnCopy

public boolean getPreserveLockingKeysOnCopy()
Deprecated. 
Overrides:
getPreserveLockingKeysOnCopy in class MaintenanceDocumentEntry
Returns:
the preserveLockingKeysOnCopy

setPreserveLockingKeysOnCopy

public void setPreserveLockingKeysOnCopy(boolean preserveLockingKeysOnCopy)
Deprecated. 
Overrides:
setPreserveLockingKeysOnCopy in class MaintenanceDocumentEntry
Parameters:
preserveLockingKeysOnCopy - the preserveLockingKeysOnCopy to set

getAllowsRecordDeletion

public boolean getAllowsRecordDeletion()
Deprecated. 
Overrides:
getAllowsRecordDeletion in class MaintenanceDocumentEntry
Returns:
the allowRecordDeletion

setAllowsRecordDeletion

public void setAllowsRecordDeletion(boolean allowsRecordDeletion)
Deprecated. 
Overrides:
setAllowsRecordDeletion in class MaintenanceDocumentEntry
Parameters:
allowsRecordDeletion - the allowRecordDeletion to set

isTranslateCodes

@Deprecated
public boolean isTranslateCodes()
Deprecated. 


setTranslateCodes

@Deprecated
public void setTranslateCodes(boolean translateCodes)
Deprecated. 


getDocumentAuthorizerClass

public Class<? extends DocumentAuthorizer> getDocumentAuthorizerClass()
Deprecated. 
Returns the document authorizer class for the document. Only framework code should be calling this method. Client devs should use DocumentTypeService#getDocumentAuthorizer(org.kuali.rice.krad.document.Document) or DocumentTypeService#getDocumentAuthorizer(String)

Specified by:
getDocumentAuthorizerClass in interface KNSDocumentEntry
Overrides:
getDocumentAuthorizerClass in class DocumentEntry
Returns:
a document authorizer class

getDocumentPresentationControllerClass

public Class<? extends DocumentPresentationController> getDocumentPresentationControllerClass()
Deprecated. 
Returns the document presentation controller class for the document. Only framework code should be calling this method. Client devs should use DocumentTypeService#getDocumentPresentationController(org.kuali.rice.krad.document.Document) or DocumentTypeService#getDocumentPresentationController(String)

Specified by:
getDocumentPresentationControllerClass in interface KNSDocumentEntry
Overrides:
getDocumentPresentationControllerClass in class DocumentEntry
Returns:
the documentPresentationControllerClass

getHeaderNavigationList

public List<HeaderNavigation> getHeaderNavigationList()
Deprecated. 
Specified by:
getHeaderNavigationList in interface KNSDocumentEntry

getWebScriptFiles

public List<String> getWebScriptFiles()
Deprecated. 
Specified by:
getWebScriptFiles in interface KNSDocumentEntry

setWebScriptFiles

public void setWebScriptFiles(List<String> webScriptFiles)
Deprecated. 
The webScriptFile element defines the name of javascript files that are necessary for processing the document. The specified javascript files will be included in the generated html.

Specified by:
setWebScriptFiles in interface KNSDocumentEntry

setHeaderNavigationList

public void setHeaderNavigationList(List<HeaderNavigation> headerNavigationList)
Deprecated. 
The headerNavigation element defines a set of additional tabs which will appear on the document.

Specified by:
setHeaderNavigationList in interface KNSDocumentEntry

isSessionDocument

public boolean isSessionDocument()
Deprecated. 
Specified by:
isSessionDocument in interface KNSDocumentEntry

setSessionDocument

public void setSessionDocument(boolean sessionDocument)
Deprecated. 
Specified by:
setSessionDocument in interface KNSDocumentEntry

getDerivedValuesSetterClass

public Class<? extends DerivedValuesSetter> getDerivedValuesSetterClass()
Deprecated. 
Specified by:
getDerivedValuesSetterClass in interface KNSDocumentEntry
Returns:
the derivedValuesSetter

setDerivedValuesSetterClass

public void setDerivedValuesSetterClass(Class<? extends DerivedValuesSetter> derivedValuesSetter)
Deprecated. 
Specified by:
setDerivedValuesSetterClass in interface KNSDocumentEntry
Parameters:
derivedValuesSetter - the derivedValuesSetter to set


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.