/*

  * Copyright 2005-2007 The Kuali Foundation

  *

  *

  * Licensed under the Educational Community License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.opensource.org/licenses/ecl2.php

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kew.doctype.bo;

 import java.lang.reflect.InvocationTargetException;

 import java.util.ArrayList;

 import java.util.Collection;

 import java.util.Collections;

 import java.util.Iterator;

 import java.util.LinkedHashMap;

 import java.util.List;

 import java.util.Set;

 import javax.persistence.Basic;

 import javax.persistence.CascadeType;

 import javax.persistence.Column;

 import javax.persistence.Entity;

 import javax.persistence.FetchType;

 import javax.persistence.Id;

 import javax.persistence.Lob;

 import javax.persistence.NamedQueries;

 import javax.persistence.NamedQuery;

 import javax.persistence.OneToMany;

 import javax.persistence.Table;

 import javax.persistence.Transient;

 import org.apache.commons.lang.StringUtils;

 import org.hibernate.annotations.Fetch;

 import org.hibernate.annotations.FetchMode;

 import org.kuali.rice.core.config.ConfigContext;

 import org.kuali.rice.core.exception.RiceRemoteServiceConnectionException;

 import org.kuali.rice.core.jpa.annotations.Sequence;

 import org.kuali.rice.core.reflect.ObjectDefinition;

 import org.kuali.rice.core.resourceloader.GlobalResourceLoader;

 import org.kuali.rice.kew.actionlist.CustomActionListAttribute;

 import org.kuali.rice.kew.bo.KewPersistableBusinessObjectBase;

 import org.kuali.rice.kew.docsearch.DocumentSearchCriteriaProcessor;

 import org.kuali.rice.kew.docsearch.DocumentSearchGenerator;

 import org.kuali.rice.kew.docsearch.DocumentSearchResultProcessor;

 import org.kuali.rice.kew.docsearch.SearchableAttribute;

 import org.kuali.rice.kew.docsearch.StandardDocumentSearchCriteriaProcessor;

 import org.kuali.rice.kew.docsearch.xml.DocumentSearchXMLResultProcessor;

 import org.kuali.rice.kew.docsearch.xml.GenericXMLSearchableAttribute;

 import org.kuali.rice.kew.doctype.ApplicationDocumentStatus;

 import org.kuali.rice.kew.doctype.DocumentTypeAttribute;

 import org.kuali.rice.kew.doctype.DocumentTypePolicy;

 import org.kuali.rice.kew.doctype.DocumentTypePolicyEnum;

 import org.kuali.rice.kew.doctype.DocumentTypeSecurity;

 import org.kuali.rice.kew.doctype.service.DocumentTypeService;

 import org.kuali.rice.kew.engine.node.Process;

 import org.kuali.rice.kew.exception.ResourceUnavailableException;

 import org.kuali.rice.kew.exception.WorkflowRuntimeException;

 import org.kuali.rice.kew.mail.CustomEmailAttribute;

 import org.kuali.rice.kew.notes.CustomNoteAttribute;

 import org.kuali.rice.kew.postprocessor.DefaultPostProcessor;

 import org.kuali.rice.kew.postprocessor.PostProcessor;

 import org.kuali.rice.kew.postprocessor.PostProcessorRemote;

 import org.kuali.rice.kew.postprocessor.PostProcessorRemoteAdapter;

 import org.kuali.rice.kew.rule.bo.RuleAttribute;

 import org.kuali.rice.kew.service.KEWServiceLocator;

 import org.kuali.rice.kew.util.CodeTranslator;

 import org.kuali.rice.kew.util.KEWConstants;

 import org.kuali.rice.kew.util.KEWPropertyConstants;

 import org.kuali.rice.kew.util.Utilities;

 import org.kuali.rice.kim.bo.Group;

 import org.kuali.rice.kim.service.IdentityManagementService;

 import org.kuali.rice.kim.service.KIMServiceLocator;

 import org.kuali.rice.kns.bo.Inactivateable;

 import org.kuali.rice.kns.datadictionary.DocumentEntry;

 import org.kuali.rice.kns.service.KNSServiceLocator;

 import org.kuali.rice.kns.util.ObjectUtils;

 import org.kuali.rice.kns.web.format.FormatException;

 /**

  * Model bean mapped to ojb representing a document type.  Provides component lookup behavior that

  * can construct {@link ObjectDefinition} objects correctly to account for ServiceNamespace inheritance.

  * Can also navigate parent hierarchy when getting data/components.

  *

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

  */

 @Entity

 @Sequence(name="KREW_DOC_HDR_S", property="documentTypeId")

 @Table(name="KREW_DOC_TYP_T")

 @NamedQueries({

     @NamedQuery(name="DocumentType.QuickLinks.FindLabelByTypeName", query="SELECT label FROM DocumentType WHERE name = :docTypeName AND currentInd = 1"),

     @NamedQuery(name="DocumentType.QuickLinks.FindInitiatedDocumentTypesListByInitiatorWorkflowId", query="SELECT DISTINCT dt.name, dt.label FROM DocumentType dt, DocumentRouteHeaderValue drhv "+

             "WHERE drhv.initiatorWorkflowId = :initiatorWorkflowId AND drhv.documentTypeId = dt.documentTypeId AND dt.active = 1 AND dt.currentInd = 1 " +

             "ORDER BY UPPER(dt.label)")

 })

 public class DocumentType extends KewPersistableBusinessObjectBase implements Inactivateable, DocumentTypeEBO {

     private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DocumentType.class);

     private static final long serialVersionUID = 1312830153583125069L;

     @Id

         @Column(name="DOC_TYP_ID")

         private Long documentTypeId;

     @Column(name="PARNT_ID")

         private Long docTypeParentId;

     @Column(name="DOC_TYP_NM")

         private String name;

     @Column(name="DOC_TYP_VER_NBR")

     private Integer version = new Integer(0);

     @Column(name="ACTV_IND")

         private Boolean active;

     @Column(name="CUR_IND")

         private Boolean currentInd;

     @Column(name="DOC_TYP_DESC")

         private String description;

     @Column(name="LBL")

         private String label;

     @Column(name="PREV_DOC_TYP_VER_NBR")

         private Long previousVersionId;

     @Column(name="DOC_HDR_ID")

         private Long routeHeaderId;

     @Column(name="HELP_DEF_URL")

     private String unresolvedHelpDefinitionUrl;

     @Column(name="DOC_SEARCH_HELP_URL")

     private String unresolvedDocSearchHelpUrl;

     @Column(name="DOC_HDLR_URL")

     private String unresolvedDocHandlerUrl;

     @Column(name="POST_PRCSR")

         private String postProcessorName;

     @Column(name="GRP_ID")

         //private Long superUserWorkgroupId;

         private String workgroupId;

     @Column(name="BLNKT_APPR_GRP_ID")

         private String blanketApproveWorkgroupId;

     @Column(name="BLNKT_APPR_PLCY")

         private String blanketApprovePolicy;

         @Column(name="RPT_GRP_ID")

         private String reportingWorkgroupId;

     @Column(name="SVC_NMSPC")

         private String actualServiceNamespace;

     /* these two fields are for the web tier lookupable

      * DocumentType is doing double-duty as a web/business tier object

      */

     @Transient

     private String returnUrl;

     @Transient

     private String actionsUrl;

     @Transient

     private Boolean applyRetroactively = Boolean.FALSE;

     /* The default exception workgroup to apply to nodes that lack an exception workgroup definition.

      * Used at parse-time only; not stored in db.

      */

     @Transient

     private Group defaultExceptionWorkgroup;

     @OneToMany(fetch=FetchType.EAGER, mappedBy="documentTypeId")

     @Fetch(value=FetchMode.SUBSELECT)

     private Collection<DocumentTypePolicy> policies;

     /* This property contains the list of valid ApplicationDocumentStatus values, 

      * if defined, for the document type.  If these status values are defined, only these

      * values may be assigned as the status.  If not valid values are defined, the status may

      * be set to any value by the client.

      */

     @OneToMany(fetch=FetchType.EAGER, cascade={CascadeType.REMOVE, CascadeType.MERGE, CascadeType.PERSIST},

                     mappedBy="documentType")

     @Fetch(value=FetchMode.SUBSELECT)

     private List<ApplicationDocumentStatus> validApplicationStatuses;

         @Transient

     private List routeLevels;

     @Transient

     private Collection childrenDocTypes;

     @Fetch(value=FetchMode.SUBSELECT)

     @OneToMany(fetch=FetchType.EAGER,cascade={CascadeType.REMOVE, CascadeType.MERGE, CascadeType.PERSIST},

            mappedBy="documentType")

         private List<DocumentTypeAttribute> documentTypeAttributes;

     /* New Workflow 2.1 Field */

     @Fetch(value=FetchMode.SUBSELECT)

     @OneToMany(fetch=FetchType.EAGER,cascade={CascadeType.REMOVE, CascadeType.MERGE, CascadeType.PERSIST},

             mappedBy="documentType")

     private List<Process> processes = new ArrayList();

     @Column(name="RTE_VER_NBR")

     private String routingVersion = KEWConstants.CURRENT_ROUTING_VERSION;

     /* Workflow 2.2 Fields */

     @Column(name="NOTIFY_ADDR")

     private String actualNotificationFromAddress;

     @Lob

         @Basic(fetch=FetchType.LAZY)

         @Column(name="SEC_XML")

         private String documentTypeSecurityXml;

     @Transient

     private DocumentTypeSecurity documentTypeSecurity;

     /* Workflow 2.4 XSLT-based email message customization */

     @Column(name="EMAIL_XSL")

         private String customEmailStylesheet;

     public DocumentType() {

         routeLevels = new ArrayList();

         documentTypeAttributes = new ArrayList<DocumentTypeAttribute>();

         policies = new ArrayList<DocumentTypePolicy>();

         version = new Integer(0);

         label = null;

     }

     public void populateDataDictionaryEditableFields(Set<String> propertyNamesEditableViaUI, DocumentType dataDictionaryEditedType) {

         String currentPropertyName = "";

         try {

             for (String propertyName : propertyNamesEditableViaUI) {

                 currentPropertyName = propertyName;

                 if (KEWPropertyConstants.PARENT_DOC_TYPE_NAME.equals(propertyName)) {

                     // this is trying to set the parent document type name so lets set the entire parent document

                     String parentDocumentTypeName = (String) ObjectUtils.getPropertyValue(dataDictionaryEditedType, propertyName);

                     if (StringUtils.isNotBlank(parentDocumentTypeName)) {

                         DocumentType parentDocType = KEWServiceLocator.getDocumentTypeService().findByName(parentDocumentTypeName);

                         if (ObjectUtils.isNull(parentDocType)) {

                             throw new WorkflowRuntimeException("Could not find valid document type for document type name '" + parentDocumentTypeName + "' to set as Parent Document Type");

                         }

                         setDocTypeParentId(parentDocType.getDocumentTypeId());

                     }

                 }

 //                else if (!FIELD_PROPERTY_NAME_DOCUMENT_TYPE_ID.equals(propertyName)) {

                 else {

                     LOG.info("*** COPYING PROPERTY NAME FROM OLD BO TO NEW BO: " + propertyName);

                     ObjectUtils.setObjectProperty(this, propertyName, ObjectUtils.getPropertyValue(dataDictionaryEditedType, propertyName));

                 }

             }

         } catch (FormatException e) {

             throw new WorkflowRuntimeException("Error setting property '" + currentPropertyName + "' in Document Type", e);

         } catch (IllegalAccessException e) {

             throw new WorkflowRuntimeException("Error setting property '" + currentPropertyName + "' in Document Type", e);

         } catch (InvocationTargetException e) {

             throw new WorkflowRuntimeException("Error setting property '" + currentPropertyName + "' in Document Type", e);

         } catch (NoSuchMethodException e) {

             throw new WorkflowRuntimeException("Error setting property '" + currentPropertyName + "' in Document Type", e);

         } catch (Exception e) {

             throw new WorkflowRuntimeException("Error setting property '" + currentPropertyName + "' in Document Type", e);

         }

     }

     public DocumentTypePolicy getAllowUnrequestedActionPolicy() {

         return getPolicyByName(DocumentTypePolicyEnum.ALLOW_UNREQUESTED_ACTION.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getDefaultApprovePolicy() {

         return getPolicyByName(DocumentTypePolicyEnum.DEFAULT_APPROVE.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getUseWorkflowSuperUserDocHandlerUrl() {

         return getPolicyByName(DocumentTypePolicyEnum.USE_KEW_SUPERUSER_DOCHANDLER.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getInitiatorMustRoutePolicy() {

         return getPolicyByName(DocumentTypePolicyEnum.INITIATOR_MUST_ROUTE.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getInitiatorMustSavePolicy() {

         return getPolicyByName(DocumentTypePolicyEnum.INITIATOR_MUST_SAVE.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getInitiatorMustCancelPolicy() {

         return getPolicyByName(DocumentTypePolicyEnum.INITIATOR_MUST_CANCEL.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getInitiatorMustBlanketApprovePolicy() {

         return getPolicyByName(DocumentTypePolicyEnum.INITIATOR_MUST_BLANKET_APPROVE.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getLookIntoFuturePolicy() {

         return getPolicyByName(DocumentTypePolicyEnum.LOOK_FUTURE.getName(), Boolean.FALSE);

     }

     public DocumentTypePolicy getSuperUserApproveNotificationPolicy() {

             return getPolicyByName(DocumentTypePolicyEnum.SEND_NOTIFICATION_ON_SU_APPROVE.getName(), Boolean.FALSE);

     }

     public DocumentTypePolicy getSupportsQuickInitiatePolicy() {

             return getPolicyByName(DocumentTypePolicyEnum.SUPPORTS_QUICK_INITIATE.getName(), Boolean.TRUE);

     }

     public DocumentTypePolicy getNotifyOnSavePolicy() {

             return getPolicyByName(DocumentTypePolicyEnum.NOTIFY_ON_SAVE.getName(), Boolean.FALSE);

     }

     /**

      * This method returns a DocumentTypePolicy object related to the DocumentStatusPolicy defined for this document type. 

      */

     public DocumentTypePolicy getDocumentStatusPolicy() {

             return getPolicyByName(DocumentTypePolicyEnum.DOCUMENT_STATUS_POLICY.getName(), KEWConstants.DOCUMENT_STATUS_POLICY_KEW_STATUS);

     }

     /**

      * This method returns a DocumentTypePolicy object related to the DocumentStatusPolicy defined for this document type. 

      */

     public DocumentTypePolicy getSuPostprocessorOverridePolicy() {

             return getPolicyByName(DocumentTypePolicyEnum.ALLOW_SU_POSTPROCESSOR_OVERRIDE_POLICY.getName(), Boolean.TRUE);

     }

     /**

      * 

      * This method returns a boolean denoting whether the KEW Route Status is to be displayed.

      * The KEW Route Status is updated by the workflow engine regardless of whether it is to be displayed or not.

      * 

      * @return  true  - if the status is to be displayed  (Policy is set to either use KEW (default) or both)

      *          false - if the KEW Route Status is not to be displayed 

      */

     public Boolean isKEWStatusInUse() {

             if (isPolicyDefined(DocumentTypePolicyEnum.DOCUMENT_STATUS_POLICY)){

                     String policyValue = getPolicyByName(DocumentTypePolicyEnum.DOCUMENT_STATUS_POLICY.getName(), KEWConstants.DOCUMENT_STATUS_POLICY_KEW_STATUS).getPolicyStringValue();

                     return (policyValue == null || "".equals(policyValue) 

                                     || KEWConstants.DOCUMENT_STATUS_POLICY_KEW_STATUS.equalsIgnoreCase(policyValue) 

                                     || KEWConstants.DOCUMENT_STATUS_POLICY_BOTH.equalsIgnoreCase(policyValue)) ? Boolean.TRUE : Boolean.FALSE;

             } else {

                     return Boolean.TRUE;

             }

     }

     /**

      * 

      * This method returns a boolean denoting whether the Application Document Status is to be used for this document type.

      * 

      * @return true  - if the status is to be displayed  (Policy is set to either use the application document status or both)

      *         false - if only the KEW Route Status is to be displayed (default)

      */

     public Boolean isAppDocStatusInUse() {

             if (isPolicyDefined(DocumentTypePolicyEnum.DOCUMENT_STATUS_POLICY)){

                     String policyValue = getPolicyByName(DocumentTypePolicyEnum.DOCUMENT_STATUS_POLICY.getName(), KEWConstants.DOCUMENT_STATUS_POLICY_KEW_STATUS).getPolicyStringValue();

                     return (KEWConstants.DOCUMENT_STATUS_POLICY_APP_DOC_STATUS.equalsIgnoreCase(policyValue) 

                                     || KEWConstants.DOCUMENT_STATUS_POLICY_BOTH.equalsIgnoreCase(policyValue)) ? Boolean.TRUE : Boolean.FALSE;

             } else {

                     return Boolean.FALSE;

             }

     }

     /**

      * 

      * This method returns a boolean denoting if both the KEW Route Status and the Application Document Status

      * are to be used in displays.

      * 

      * @return  true  - if both the KEW Route Status and Application Document Status are to be displayed.

      *          false - if only one status is to be displayed. 

      */

     public Boolean areBothStatusesInUse() {

             if (isPolicyDefined(DocumentTypePolicyEnum.DOCUMENT_STATUS_POLICY)){

                     String policyValue = getPolicyByName(DocumentTypePolicyEnum.DOCUMENT_STATUS_POLICY.getName(), KEWConstants.DOCUMENT_STATUS_POLICY_KEW_STATUS).getPolicyStringValue();

                     return (KEWConstants.DOCUMENT_STATUS_POLICY_BOTH.equalsIgnoreCase(policyValue)) ? Boolean.TRUE : Boolean.FALSE;

             } else {

                     return Boolean.FALSE;

             }

     }

     public String getUseWorkflowSuperUserDocHandlerUrlValue() {

         if (getUseWorkflowSuperUserDocHandlerUrl() != null) {

             return getUseWorkflowSuperUserDocHandlerUrl().getPolicyDisplayValue();

         }

         return null;

     }

     public String getAllowUnrequestedActionPolicyDisplayValue() {

         if (getAllowUnrequestedActionPolicy() != null) {

             return getAllowUnrequestedActionPolicy().getPolicyDisplayValue();

         }

         return null;

     }

     public String getDefaultApprovePolicyDisplayValue() {

         if (getDefaultApprovePolicy() != null) {

             return getDefaultApprovePolicy().getPolicyDisplayValue();

         }

         return null;

     }

     public String getInitiatorMustRouteDisplayValue() {

         if (getInitiatorMustRoutePolicy() != null) {

             return getInitiatorMustRoutePolicy().getPolicyDisplayValue();

         }

         return null;

     }

     public String getInitiatorMustSaveDisplayValue() {

         if (getInitiatorMustSavePolicy() != null) {

             return getInitiatorMustSavePolicy().getPolicyDisplayValue();

         }

         return null;

     }

     public boolean isPolicyDefined(DocumentTypePolicyEnum policyToCheck) {

             Iterator<DocumentTypePolicy> policyIter = getPolicies().iterator();

         while (policyIter.hasNext()) {

             DocumentTypePolicy policy = policyIter.next();

             if (policyToCheck.getName().equals(policy.getPolicyName())) {

                     return true;

             }

         }

         return getParentDocType() != null && getParentDocType().isPolicyDefined(policyToCheck);

     }

     public void addSearchableAttribute(DocumentTypeAttribute searchableAttribute) {

             documentTypeAttributes.add(searchableAttribute);

     }

     public boolean hasSearchableAttributes() {

             return ! getSearchableAttributes().isEmpty();

     }

     public List<SearchableAttribute> getSearchableAttributes() {

             List<SearchableAttribute> searchAtts = new ArrayList<SearchableAttribute>();

             if ((documentTypeAttributes == null || documentTypeAttributes.isEmpty())) {

                     if (getParentDocType() != null) {

                             return getParentDocType().getSearchableAttributes();

                     } else {

                             return searchAtts;

                     }

             }

             for (Iterator iterator = documentTypeAttributes.iterator(); iterator.hasNext();) {

                         DocumentTypeAttribute attribute = (DocumentTypeAttribute) iterator.next();

 //                        String attributeType = attribute.getRuleAttribute().getType();

                         RuleAttribute ruleAttribute = attribute.getRuleAttribute();

                         SearchableAttribute searchableAttribute = null;

                         if (KEWConstants.SEARCHABLE_ATTRIBUTE_TYPE.equals(ruleAttribute.getType())) {

                                 ObjectDefinition objDef = getAttributeObjectDefinition(ruleAttribute);

                                 try {

                                     searchableAttribute = (SearchableAttribute) GlobalResourceLoader.getObject(objDef);

                                 } catch (RiceRemoteServiceConnectionException e) {

                                     LOG.warn("Unable to connect to load searchable attributes for " + this.getName());

                                     LOG.warn(e.getMessage());

                                     searchableAttribute = null;

                                 }

                         } else if (KEWConstants.SEARCHABLE_XML_ATTRIBUTE_TYPE.equals(ruleAttribute.getType())) {

                                 ObjectDefinition objDef = getAttributeObjectDefinition(ruleAttribute);

                                 searchableAttribute = (SearchableAttribute) GlobalResourceLoader.getObject(objDef);

                                 //required to make it work because ruleAttribute XML is required to construct fields

                                 ((GenericXMLSearchableAttribute) searchableAttribute).setRuleAttribute(ruleAttribute);

                         }

                         if (searchableAttribute != null) {

                                 searchAtts.add(searchableAttribute);

                         }

                 }

             return searchAtts;

     }

     public DocumentTypeAttribute getDocumentTypeAttribute(int index) {

         while (getDocumentTypeAttributes().size() <= index) {

                 DocumentTypeAttribute attribute = new DocumentTypeAttribute();

             //attribute.setDocumentTypeId(this.documentTypeId);

             getDocumentTypeAttributes().add(attribute);

         }

         return (DocumentTypeAttribute) getDocumentTypeAttributes().get(index);

     }

     public void setDocumentTypeAttribute(int index, DocumentTypeAttribute documentTypeAttribute) {

             documentTypeAttributes.set(index, documentTypeAttribute);

     }

     public String getDocTypeActiveIndicatorDisplayValue() {

         if (getActive() == null) {

             return KEWConstants.INACTIVE_LABEL_LOWER;

         }

         return CodeTranslator.getActiveIndicatorLabel(getActive());

     }

     public Collection getChildrenDocTypes() {

             if (this.childrenDocTypes == null) {

                     this.childrenDocTypes = KEWServiceLocator.getDocumentTypeService().getChildDocumentTypes(getDocumentTypeId());

             }

         return childrenDocTypes;

     }

     public java.lang.Long getDocTypeParentId() {

         return docTypeParentId;

     }

     public void setDocTypeParentId(java.lang.Long docTypeParentId) {

         this.docTypeParentId = docTypeParentId;

     }

     public DocumentType getParentDocType() {

         return KEWServiceLocator.getDocumentTypeService().findById(this.docTypeParentId);

     }

     public Collection<DocumentTypePolicy> getPolicies() {

         return policies;

     }

     public void setPolicies(Collection<DocumentTypePolicy> policies) {

         this.policies = policies;

     }

     public List<ApplicationDocumentStatus> getValidApplicationStatuses() {

                 return this.validApplicationStatuses;

         }

         public void setValidApplicationStatuses(

                         List<ApplicationDocumentStatus> validApplicationStatuses) {

                 this.validApplicationStatuses = validApplicationStatuses;

         }

     public String getDocumentTypeSecurityXml() {

       return documentTypeSecurityXml;

     }

     public void setDocumentTypeSecurityXml(String documentTypeSecurityXml) {

       this.documentTypeSecurityXml = documentTypeSecurityXml;

       if (!Utilities.isEmpty(documentTypeSecurityXml.trim())) {

         this.documentTypeSecurity = new DocumentTypeSecurity(this.getServiceNamespace(), documentTypeSecurityXml);

       }

       else {

         this.documentTypeSecurity = null;

       }

     }

     public DocumentTypeSecurity getDocumentTypeSecurity()  {

       if (this.documentTypeSecurity == null &&

           this.documentTypeSecurityXml != null &&

           !Utilities.isEmpty(documentTypeSecurityXml.trim()))

       {

            this.documentTypeSecurity = new DocumentTypeSecurity(this.getServiceNamespace(), documentTypeSecurityXml);

       }

       if ( (this.documentTypeSecurity == null) && (getParentDocType() != null) ) {

               return getParentDocType().getDocumentTypeSecurity();

       }

       return this.documentTypeSecurity;

     }

     public List getRouteLevels() {

         if (routeLevels.isEmpty() && getParentDocType() != null) {

             return getParentRouteLevels(getParentDocType());

         }

         return routeLevels;

     }

     private List getParentRouteLevels(DocumentType parent) {

         if (parent.getRouteLevels() == null) {

             return getParentRouteLevels(parent.getParentDocType());

         } else {

             return parent.getRouteLevels();

         }

     }

     public void setRouteLevels(List routeLevels) {

         this.routeLevels = routeLevels;

     }

     public String getActionsUrl() {

         return actionsUrl;

     }

     public void setActionsUrl(String actions) {

         this.actionsUrl = actions;

     }

     public Boolean getActive() {

         return active;

     }

     public void setActive(java.lang.Boolean activeInd) {

         this.active = activeInd;

     }

     public java.lang.Boolean getCurrentInd() {

         return currentInd;

     }

     public void setCurrentInd(java.lang.Boolean currentInd) {

         this.currentInd = currentInd;

     }

     public java.lang.String getDescription() {

         return description;

     }

     public void setDescription(java.lang.String description) {

         this.description = description;

     }

     /**

      * This method gets the document handler url from this object or from a parent document type and resolves any

      * potential variables that may be in use

      */

     public String getDocHandlerUrl() {

         return resolveDocHandlerUrl(getUnresolvedInheritedDocHandlerUrl(false));

     }

     /**

      * This method retrieves the unresolved document handler URL either from this object or from a parent document type

      * object. If the forDisplayPurposes value is true the value returned will be invalid for system use.

      *

      * This method will first call the {@link #getUnresolvedDocHandlerUrl()} method to check for a value on this object.

      * If none is found a parent document type must exist because the document handler URL is required and is used. The

      * system will use inheritance to find the document handler url from a document type somewhere in the hierarchy.

      *

      * @param forDisplayPurposes - if true then the string returned will have a label explaining where the value came from

      * @return the unresolved document handler URL value or a displayable value with sourcing information

      */

     protected String getUnresolvedInheritedDocHandlerUrl(boolean forDisplayPurposes) {

         if (StringUtils.isNotBlank(getUnresolvedDocHandlerUrl())) {

             // this object has a direct value set, so return it

             return getUnresolvedDocHandlerUrl();

         }

         // check for a parent document to see if the doc handler url can be inherited

         DocumentType docType = getParentDocType();

         if (ObjectUtils.isNotNull(docType)) {

             String parentValue = docType.getUnresolvedDocHandlerUrl();

             if (StringUtils.isNotBlank(parentValue)) {

                 // found a parent value set on the immediate parent object so return it

                 if (forDisplayPurposes) {

                     parentValue += " " + KEWConstants.DOCUMENT_TYPE_INHERITED_VALUE_INDICATOR;

                 }

                 return parentValue;

             }

             // no valid value exists on the immediate parent, so check the hierarchy

             return docType.getUnresolvedInheritedDocHandlerUrl(forDisplayPurposes);

         }

         return null;

     }

     /**

      * Returns the same value as the {@link #getUnresolvedInheritedDocHandlerUrl(boolean)} method but will also have label

      * information about whether the value returned came from this object or the parent document type associated with this object

      */

     public String getDisplayableUnresolvedDocHandlerUrl() {

         return getUnresolvedInheritedDocHandlerUrl(true);

     }

     /**

      * EMPTY METHOD. Use {@link #setUnresolvedDocHandlerUrl(String)} instead.

      * @deprecated

      */

     public void setDisplayableUnresolvedDocHandlerUrl(String displayableUnresolvedDocHandlerUrl) {

         // do nothing

     }

     /**

      * @return the unresolvedDocHandlerUrl

      */

     public String getUnresolvedDocHandlerUrl() {

         return this.unresolvedDocHandlerUrl;

     }

     /**

      * @param unresolvedDocHandlerUrl the unresolvedDocHandlerUrl to set

      */

     public void setUnresolvedDocHandlerUrl(String unresolvedDocHandlerUrl) {

         this.unresolvedDocHandlerUrl = unresolvedDocHandlerUrl;

     }

     /**

      * If the doc handler URL has variables in it that need to be replaced, this will look up the values

      * for those variables and replace them in the doc handler URL.

      */

     protected String resolveDocHandlerUrl(String docHandlerUrl) {

             if (StringUtils.isBlank(docHandlerUrl)) {

                     return "";

             }

             return Utilities.substituteConfigParameters(getServiceNamespace(), docHandlerUrl);

     }

     /**

      * Use {@link #setDocHandlerUrl(String)} to add a document handler url to this object.

      * @deprecated

      */

     public void setDocHandlerUrl(java.lang.String docHandlerUrl) {

         setUnresolvedDocHandlerUrl(docHandlerUrl);

     }

     /**

      * @return the unresolvedHelpDefinitionUrl

      */

     public String getUnresolvedHelpDefinitionUrl() {

         return this.unresolvedHelpDefinitionUrl;

     }

     /**

      * @param unresolvedHelpDefinitionUrl the unresolvedHelpDefinitionUrl to set

      */

     public void setUnresolvedHelpDefinitionUrl(String unresolvedHelpDefinitionUrl) {

         this.unresolvedHelpDefinitionUrl = unresolvedHelpDefinitionUrl;

     }

     /**

      * This method gets the help definition url from this object and resolves any 

      * potential variables that may be in use

      */

     public String getHelpDefinitionUrl() {

         return resolveHelpUrl(getUnresolvedHelpDefinitionUrl());

     }

     /**

      * If a help URL has variables in it that need to be replaced, this will look up the values

      * for those variables and replace them.

      */

     protected String resolveHelpUrl(String helpDefinitionUrl) {

         if (StringUtils.isBlank(helpDefinitionUrl)) {

             return "";

         }

         return Utilities.substituteConfigParameters(helpDefinitionUrl);

     }

     /**

      * @return the unresolvedDocSearchHelpUrl

      */

     public String getUnresolvedDocSearchHelpUrl() {

         return this.unresolvedDocSearchHelpUrl;

     }

     /**

      * @param unresolvedDocSearchHelpUrl the unresolvedDocSearchHelpUrl to set

      */

     public void setUnresolvedDocSearchHelpUrl(String unresolvedDocSearchHelpUrl) {

         this.unresolvedDocSearchHelpUrl = unresolvedDocSearchHelpUrl;

     }

     /**

      * This method gets the doc search help url from this object and resolves any 

      * potential variables that may be in use

      */

     public String getDocSearchHelpUrl() {

         return resolveHelpUrl(getUnresolvedDocSearchHelpUrl());

     }

     public java.lang.String getLabel() {

         return label;

     }

     public void setLabel(java.lang.String label) {

         this.label = label;

     }

     public java.lang.String getName() {

         return name;

     }

     public void setName(java.lang.String name) {

         this.name = name;

     }

     public PostProcessor getPostProcessor() {

         String pname = getPostProcessorName();

         if (StringUtils.equals(pname, KEWConstants.POST_PROCESSOR_NON_DEFINED_VALUE)) { 

             return new DefaultPostProcessor();    

         }

         if (StringUtils.isBlank(pname)) {

             if (getParentDocType() != null) {

                 return getParentDocType().getPostProcessor();

             } else {

                 return new DefaultPostProcessor();

             }

         }

         ObjectDefinition objDef = getObjectDefinition(pname);

         Object postProcessor = GlobalResourceLoader.getObject(objDef);

         if (postProcessor == null) {

             throw new WorkflowRuntimeException("Could not locate PostProcessor in this JVM or at service namespace " + getServiceNamespace() + ": " + pname);

         }

         if (postProcessor instanceof PostProcessorRemote) {

             postProcessor = new PostProcessorRemoteAdapter((PostProcessorRemote)postProcessor);

         }

         return (PostProcessor)postProcessor;

     }

     /**

      * This method gets the post processor class value. If the forDisplayPurposes value is true

      * the value will be invalid for system use.

      *

      * This method will first call the {@link #getPostProcessorName()} method to check the value on this object.

      * If none is found the system checks for a parent document type.  If a valid parent type exists for this document type

      * then the system will use inheritance from that parent document type as long as at least one document type in the

      * hierarchy has a value set.  If no value is set on any parent document type or if no parent document type exists the

      * system will return null.

      *

      * @param forDisplayPurposes - if true then the string returned will have a label explaining where the value came from

      * @return the post processor class value or a displayable value with sourcing information

      */

     protected String getInheritedPostProcessorName(boolean forDisplayPurposes) {

         if (StringUtils.isNotBlank(getPostProcessorName())) {

             // this object has a post processor class so return it

             return getPostProcessorName();

         }

         if (ObjectUtils.isNotNull(getParentDocType())) {

             // direct parent document type exists

             String parentValue = getParentDocType().getPostProcessorName();

             if (StringUtils.isNotBlank(parentValue)) {

                 // found a post processor class set on the immediate parent object so return it

                 if (forDisplayPurposes) {

                     parentValue += " " + KEWConstants.DOCUMENT_TYPE_INHERITED_VALUE_INDICATOR;

                 }

                 return parentValue;

             }

             // did not find a valid value on the immediate parent, so use hierarchy

             return getParentDocType().getInheritedPostProcessorName(forDisplayPurposes);

         }

         return null;

     }

     public java.lang.String getPostProcessorName() {

         return postProcessorName;

     }

     public void setPostProcessorName(java.lang.String postProcessorName) {

         this.postProcessorName = postProcessorName;

     }

     public String getDisplayablePostProcessorName() {

         return getInheritedPostProcessorName(true);

     }

     /**

      * EMPTY METHOD. Use {@link #setPostProcessorName(String)} instead.

      * @deprecated

      */

     public void setDisplayablePostProcessorName(String displayablePostProcessorName) {

         // do nothing

     }

     public java.lang.Long getPreviousVersionId() {

         return previousVersionId;

     }

     public void setPreviousVersionId(java.lang.Long previousVersionId) {

         this.previousVersionId = previousVersionId;

     }

     public java.lang.Long getRouteHeaderId() {

         return routeHeaderId;

     }

     public void setRouteHeaderId(java.lang.Long routeHeaderId) {

         this.routeHeaderId = routeHeaderId;

     }

     public java.lang.Integer getVersion() {

         return version;

     }

     public void setVersion(java.lang.Integer version) {

         this.version = version;

     }

     public java.lang.Long getDocumentTypeId() {

         return documentTypeId;

     }

     public void setDocumentTypeId(java.lang.Long docTypeGrpId) {

         this.documentTypeId = docTypeGrpId;

     }

     public Object copy(boolean preserveKeys) {

         throw new UnsupportedOperationException("The copy method is deprecated and unimplemented!");

     }

     public java.lang.String getReturnUrl() {

         return returnUrl;

     }

     public void setReturnUrl(java.lang.String returnUrl) {

         this.returnUrl = returnUrl;

     }

     private DocumentTypePolicy getPolicyByName(String policyName, Boolean defaultValue) {

         Iterator policyIter = getPolicies().iterator();

         while (policyIter.hasNext()) {

             DocumentTypePolicy policy = (DocumentTypePolicy) policyIter.next();

             if (policyName.equals(policy.getPolicyName())) {

                 policy.setInheritedFlag(Boolean.FALSE);

                 return policy;

             }

         }

         if (getParentDocType() != null) {

             DocumentTypePolicy policy = getParentDocType().getPolicyByName(policyName, defaultValue);

             policy.setInheritedFlag(Boolean.TRUE);

             if (policy.getPolicyValue() == null) {

                 policy.setPolicyValue(Boolean.TRUE);

             }

             return policy;

         }

         DocumentTypePolicy policy = new DocumentTypePolicy();

         policy.setPolicyName(policyName);

         policy.setInheritedFlag(Boolean.FALSE);

         policy.setPolicyValue(defaultValue);

         return policy;

     }

     private DocumentTypePolicy getPolicyByName(String policyName, String defaultValue) {

         Iterator policyIter = getPolicies().iterator();

         while (policyIter.hasNext()) {

             DocumentTypePolicy policy = (DocumentTypePolicy) policyIter.next();

             if (policyName.equals(policy.getPolicyName())) {

                 policy.setInheritedFlag(Boolean.FALSE);

                 return policy;

             }

         }

         if (getParentDocType() != null) {

             DocumentTypePolicy policy = getParentDocType().getPolicyByName(policyName, defaultValue);

             policy.setInheritedFlag(Boolean.TRUE);

             if (policy.getPolicyValue() == null) {

                 policy.setPolicyValue(Boolean.TRUE);

             }

             return policy;

         }

         DocumentTypePolicy policy = new DocumentTypePolicy();

         policy.setPolicyName(policyName);

         policy.setInheritedFlag(Boolean.FALSE);

         policy.setPolicyValue(Boolean.TRUE);

         policy.setPolicyStringValue(defaultValue);

         return policy;

     }

     private DocumentTypeService getDocumentTypeService() {

         return (DocumentTypeService) KEWServiceLocator.getService(KEWServiceLocator.DOCUMENT_TYPE_SERVICE);

     }

     public Group getSuperUserWorkgroup() {

         Group superUserWorkgroup = getSuperUserWorkgroupNoInheritence();

         if (superUserWorkgroup == null && getParentDocType() != null) {

             return getParentDocType().getSuperUserWorkgroup();

         }

         return superUserWorkgroup;

     }

     public Group getSuperUserWorkgroupNoInheritence() {

         if (workgroupId == null) {

             return null;

         }

         return getIdentityManagementService().getGroup(this.workgroupId);

     }

     public void setSuperUserWorkgroupNoInheritence(Group suWorkgroup) {

         this.workgroupId = null;

         if (ObjectUtils.isNotNull(suWorkgroup)) {

             this.workgroupId = suWorkgroup.getGroupId();

         }

     }

     /**

      * Returns true if this DocumentType has a super user group defined.

      */

     public boolean isSuperUserGroupDefined() {

             if (this.workgroupId == null) {

                     return getParentDocType() != null && getParentDocType().isSuperUserGroupDefined();

             }

             return true;

     }

     public DocumentType getPreviousVersion() {

         return getDocumentTypeService().findById(previousVersionId);

     }

     public Group getBlanketApproveWorkgroup() {

         return getIdentityManagementService().getGroup(blanketApproveWorkgroupId);

     }

     public void setBlanketApproveWorkgroup(Group blanketApproveWorkgroup) {

         this.blanketApproveWorkgroupId = null;

         if (ObjectUtils.isNotNull(blanketApproveWorkgroup)) {

             this.blanketApproveWorkgroupId = blanketApproveWorkgroup.getGroupId();

         }

     }

         public String getBlanketApprovePolicy() {

                 return this.blanketApprovePolicy;

         }

         public void setBlanketApprovePolicy(String blanketApprovePolicy) {

                 this.blanketApprovePolicy = blanketApprovePolicy;

         }

     public Group getBlanketApproveWorkgroupWithInheritance() {

             if (getParentDocType() != null && this.blanketApproveWorkgroupId == null) {

                     return getParentDocType().getBlanketApproveWorkgroupWithInheritance();

             }

         return getIdentityManagementService().getGroup(blanketApproveWorkgroupId);

     }

     public boolean isBlanketApprover(String principalId) {

             if (KEWConstants.DOCUMENT_TYPE_BLANKET_APPROVE_POLICY_NONE.equalsIgnoreCase(getBlanketApprovePolicy())) {

                     // no one can blanket approve this doc type

                     return false;

             } else if (KEWConstants.DOCUMENT_TYPE_BLANKET_APPROVE_POLICY_ANY.equalsIgnoreCase(getBlanketApprovePolicy())) {

                     // anyone can blanket approve this doc type

                     return true;

             }

             if (blanketApproveWorkgroupId != null) {

                     return getIdentityManagementService().isMemberOfGroup(principalId, blanketApproveWorkgroupId);

             }

             DocumentType parentDoc = getParentDocType();

             if (parentDoc != null) {

                     // found parent doc so try to get blanket approver info from it

                     return parentDoc.isBlanketApprover(principalId);

             }

             return false;

     }

     /**

      * Returns true if either a blanket approve group or blanket approve policy is defined

      * on this Document Type.

      */

     public boolean isBlanketApproveGroupDefined() {

             if (StringUtils.isBlank(getBlanketApprovePolicy()) && this.blanketApproveWorkgroupId == null) {

                     return getParentDocType() != null && getParentDocType().isBlanketApproveGroupDefined();

             }

             return true;

     }

     /**

      * @return the reportingWorkgroupId

      */

     public String getReportingWorkgroupId() {

         return this.reportingWorkgroupId;

     }

     /**

      * @param reportingWorkgroupId the reportingWorkgroupId to set

      */

     public void setReportingWorkgroupId(String reportingWorkgroupId) {

         this.reportingWorkgroupId = reportingWorkgroupId;

     }

     public Group getReportingWorkgroup() {

         return getIdentityManagementService().getGroup(this.reportingWorkgroupId);

     }

     public void setReportingWorkgroup(Group reportingWorkgroup) {

         this.reportingWorkgroupId = null;

         if (ObjectUtils.isNotNull(reportingWorkgroup)) {

             this.reportingWorkgroupId = reportingWorkgroup.getGroupId();

         }

     }

     public Group getDefaultExceptionWorkgroup() {

         return defaultExceptionWorkgroup;

     }

     public void setDefaultExceptionWorkgroup(Group defaultExceptionWorkgroup) {

         this.defaultExceptionWorkgroup = defaultExceptionWorkgroup;

     }

     public DocumentSearchGenerator getDocumentSearchGenerator() {

         DocumentEntry documentEntry = KNSServiceLocator.getDataDictionaryService().getDataDictionary().getDocumentEntry(this.getName());

         Class<? extends DocumentSearchGenerator> docSearchGeneratorClass = null;

         if (documentEntry != null) {

             docSearchGeneratorClass = documentEntry.getDocumentSearchGeneratorClass();

         }

         if (docSearchGeneratorClass == null) {

             ObjectDefinition objDef = getAttributeObjectDefinition(KEWConstants.SEARCH_GENERATOR_ATTRIBUTE_TYPE);

                 if (objDef == null) {

                         if (getParentDocType() != null) {

                                 return getParentDocType().getDocumentSearchGenerator();

                         } else {

                     DocumentSearchGenerator generator = KEWServiceLocator.getDocumentSearchService().getStandardDocumentSearchGenerator();

                             return generator;

                         }

                 }

                 Object searchGenerator = null;

                 try {

                     searchGenerator = GlobalResourceLoader.getObject(objDef);

                 } catch (RiceRemoteServiceConnectionException e) {

                     LOG.warn("Unable to connect to load searchGenerator for " + this.getName()+ ".  Using StandardDocumentSearchGenerator as default.");

                     LOG.warn(e.getMessage());

                     return KEWServiceLocator.getDocumentSearchService().getStandardDocumentSearchGenerator();

                 }

             if (searchGenerator == null) {

                 throw new WorkflowRuntimeException("Could not locate DocumentSearchGenerator in this JVM or at service namespace " + getServiceNamespace() + ": " + objDef.getClassName());

             }

             DocumentSearchGenerator docSearchGenerator = (DocumentSearchGenerator)searchGenerator;

             return docSearchGenerator;

         } else {

             try {

                 DocumentSearchGenerator docSearchGenerator = (DocumentSearchGenerator)docSearchGeneratorClass.newInstance();

                 return docSearchGenerator;

             } catch (InstantiationException e) {

                 throw new WorkflowRuntimeException("Could not locate DocumentSearchGenerator defined in data dictionary " );

             } catch (IllegalAccessException e) {

                 throw new WorkflowRuntimeException("Could not locate DocumentSearchGenerator defined in data dictionary " );

             }

         }

     }

     public DocumentSearchCriteriaProcessor getDocumentSearchCriteriaProcessor() {

             ObjectDefinition objDef = getAttributeObjectDefinition(KEWConstants.SEARCH_CRITERIA_PROCESSOR_ATTRIBUTE_TYPE);

             if (objDef == null) {

                     if (getParentDocType() != null) {

                             return getParentDocType().getDocumentSearchCriteriaProcessor();

                     } else {

                 return new StandardDocumentSearchCriteriaProcessor();

                     }

             }

         Object criteriaProcessor = GlobalResourceLoader.getObject(objDef);

         if (criteriaProcessor == null) {

             throw new WorkflowRuntimeException("Could not locate DocumentSearchCriteriaProcessor in this JVM or at service namespace " + getServiceNamespace() + ": " + objDef.getClassName());

         }

         return (DocumentSearchCriteriaProcessor) criteriaProcessor;

     }

     public DocumentSearchResultProcessor getDocumentSearchResultProcessor() {

             if ((documentTypeAttributes == null || documentTypeAttributes.isEmpty())) {

                     if (getParentDocType() != null) {

                             return getParentDocType().getDocumentSearchResultProcessor();

                     } else {

                         return KEWServiceLocator.getDocumentSearchService().getStandardDocumentSearchResultProcessor();

 //                     return new StandardDocumentSearchResultProcessor();

                     }

             }

             for (Iterator iterator = documentTypeAttributes.iterator(); iterator.hasNext();) {

                         DocumentTypeAttribute attribute = (DocumentTypeAttribute) iterator.next();

                         RuleAttribute ruleAttribute = attribute.getRuleAttribute();

                         if (KEWConstants.SEARCH_RESULT_PROCESSOR_ATTRIBUTE_TYPE.equals(ruleAttribute.getType())) {

                                 ObjectDefinition objDef = getAttributeObjectDefinition(ruleAttribute);

                                 return (DocumentSearchResultProcessor) GlobalResourceLoader.getObject(objDef);

                         } else if (KEWConstants.SEARCH_RESULT_XML_PROCESSOR_ATTRIBUTE_TYPE.equals(ruleAttribute.getType())) {

                                 ObjectDefinition objDef = getAttributeObjectDefinition(ruleAttribute);

                                 DocumentSearchResultProcessor resultProcessor = (DocumentSearchResultProcessor) GlobalResourceLoader.getObject(objDef);

                                 //required to make it work because ruleAttribute XML is required to construct custom columns

                                 ((DocumentSearchXMLResultProcessor) resultProcessor).setRuleAttribute(ruleAttribute);

                                 return resultProcessor;

                         }

                 }

             return KEWServiceLocator.getDocumentSearchService().getStandardDocumentSearchResultProcessor();

 //            return new StandardDocumentSearchResultProcessor();

     }

     public CustomActionListAttribute getCustomActionListAttribute() throws ResourceUnavailableException {

             ObjectDefinition objDef = getAttributeObjectDefinition(KEWConstants.ACTION_LIST_ATTRIBUTE_TYPE);

             if (objDef == null) {

                     return null;

             }

         try {

             return (CustomActionListAttribute)GlobalResourceLoader.getObject(objDef);

         } catch (RuntimeException e) {

             LOG.error("Error obtaining custom action list attribute: " + objDef, e);

             throw e;

         }

     }

     public CustomEmailAttribute getCustomEmailAttribute() throws ResourceUnavailableException {

             ObjectDefinition objDef = getAttributeObjectDefinition(KEWConstants.EMAIL_ATTRIBUTE_TYPE);

             if (objDef == null) {

                     return null;

             }

             return (CustomEmailAttribute)GlobalResourceLoader.getObject(objDef);

     }

     public ObjectDefinition getAttributeObjectDefinition(String typeCode) {

             for (Iterator iter = getDocumentTypeAttributes().iterator(); iter.hasNext();) {

                     RuleAttribute attribute = ((DocumentTypeAttribute)iter.next()).getRuleAttribute();

                     if (attribute.getType().equals(typeCode)) {

                             return getAttributeObjectDefinition(attribute);

                     }

                 }

             if (getParentDocType() != null) {

                     return getParentDocType().getAttributeObjectDefinition(typeCode);

             }

         return null;

     }

     public ObjectDefinition getAttributeObjectDefinition(RuleAttribute ruleAttribute) {

             if (ruleAttribute.getServiceNamespace() == null) {

                     return new ObjectDefinition(ruleAttribute.getClassName(), this.getServiceNamespace());

             } else {

                     return new ObjectDefinition(ruleAttribute.getClassName(), ruleAttribute.getServiceNamespace());

             }

     }

     public CustomNoteAttribute getCustomNoteAttribute() throws ResourceUnavailableException {

             ObjectDefinition objDef = getAttributeObjectDefinition(KEWConstants.NOTE_ATTRIBUTE_TYPE);

             if (objDef == null) {

                     String defaultNoteClass = ConfigContext.getCurrentContextConfig().getDefaultKewNoteClass();

                     if (defaultNoteClass == null) {

                         // attempt to use deprecated parameter

                         defaultNoteClass = ConfigContext.getCurrentContextConfig().getDefaultNoteClass();

                         if (ObjectUtils.isNull(defaultNoteClass)) {

                             return null;

                         }

                     }

                     objDef = new ObjectDefinition(defaultNoteClass);

             }

             return (CustomNoteAttribute)GlobalResourceLoader.getObject(objDef);

     }

     public ObjectDefinition getObjectDefinition(String objectName) {

             return new ObjectDefinition(objectName, getServiceNamespace());

     }

     /**

      * Returns true if this document type defines it's own routing, false if it inherits its routing

      * from a parent document type.

      */

     public boolean isRouteInherited() {

         return processes.isEmpty() && getParentDocType() != null;

     }

     /**

      * Returns the DocumentType which defines the route for this document.  This is the DocumentType

      * from which we inherit our Processes which define our routing.

      */

     public DocumentType getRouteDefiningDocumentType() {

         if (isRouteInherited()) {

             return getParentDocType().getRouteDefiningDocumentType();

         }

         return this;

     }

         public boolean isDocTypeActive() {

         if (!getActive().booleanValue()) {

             return false;

         }

         if (getParentDocType() != null) {

             if (!getParentActiveInd(getParentDocType())) {

                 return false;

             }

         }

         return true;

     }

     private boolean getParentActiveInd(DocumentType parentDocType) {

         if (parentDocType.getActive() == null || parentDocType.getActive().booleanValue()) {

             if (parentDocType.getParentDocType() != null) {

                 return getParentActiveInd(parentDocType.getParentDocType());

             }

             return true;

         } else {

             return false;

         }

     }

         /**

          * @param documentTypeAttributes The documentTypeAttributes to set.

          */

         public void setDocumentTypeAttributes(List<DocumentTypeAttribute> documentTypeAttributes) {