org.kuali.rice.kns.datadictionary

Class TransactionalDocumentEntry

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.TransactionalDocumentEntry

org.kuali.rice.kns.datadictionary.TransactionalDocumentEntry

All Implemented Interfaces:

Serializable, Cloneable, KNSDocumentEntry, Copyable, DataDictionaryEntry, DictionaryBean

Deprecated.

Use TransactionalDocumentEntry.

@Deprecated
public class TransactionalDocumentEntry
extends TransactionalDocumentEntry
implements KNSDocumentEntry

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends DerivedValuesSetter>	derivedValuesSetterClass Deprecated.
protected List<HeaderNavigation>	headerNavigationList Deprecated.
protected Class<? extends PromptBeforeValidation>	promptBeforeValidationClass Deprecated.
protected boolean	sessionDocument Deprecated.
protected List<String>	webScriptFiles Deprecated.

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
TransactionalDocumentEntry() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation() Deprecated. Directly validate simple fields, call completeValidation on Definition fields.
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.
List<HeaderNavigation>	getHeaderNavigationList() Deprecated.
Class<? extends PromptBeforeValidation>	getPromptBeforeValidationClass() Deprecated.
List<String>	getWebScriptFiles() Deprecated.
boolean	isSessionDocument() 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	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	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.TransactionalDocumentEntry

getStandardDocumentBaseClass

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

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

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

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, 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

completeValidation, getAttributeDefinition, getFullClassName, getJstlKey, getRelationships, getStateMapping, setStateMapping

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

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

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

TransactionalDocumentEntry

public TransactionalDocumentEntry()

Deprecated.

Method Detail

getHeaderNavigationList

public List<HeaderNavigation> getHeaderNavigationList()

Deprecated.

Specified by:

getHeaderNavigationList in interface KNSDocumentEntry

getWebScriptFiles

public List<String> getWebScriptFiles()

Deprecated.

Specified by:

getWebScriptFiles in interface KNSDocumentEntry

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)

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

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

completeValidation

public void completeValidation()

Deprecated.

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

See Also:

DataDictionaryEntryBase.completeValidation()

toString

public String toString()

Deprecated.

Overrides:

toString in class Object