org.kuali.rice.kew.doctype.bo
Class DocumentType

java.lang.Object
  extended by org.kuali.rice.krad.bo.BusinessObjectBase
      extended by org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          extended by org.kuali.rice.kew.doctype.bo.DocumentType
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Inactivatable, MutableInactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, DocumentTypeContract, DocumentTypeEBO, BusinessObject, ExternalizableBusinessObject, PersistableBusinessObject

@Entity
public class DocumentType
extends PersistableBusinessObjectBase
implements MutableInactivatable, DocumentTypeEBO, DocumentTypeContract

Model bean mapped to ojb representing a document type. Provides component lookup behavior that can construct ObjectDefinition objects correctly to account for application id inheritance. Can also navigate parent hierarchy when getting data/components.

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

Nested Class Summary
static class DocumentType.ExtensionHolder<T>
           
 
Field Summary
 
Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
extension, versionNumber
 
Constructor Summary
DocumentType()
           
 
Method Summary
 void addProcess(ProcessDefinitionBo process)
           
 Boolean areBothStatusesInUse()
          This method returns a boolean denoting if both the KEW Route Status and the Application Document Status are to be used in displays.
 Object copy(boolean preserveKeys)
           
static DocumentType from(DocumentTypeContract dt)
           
 String getActionsUrl()
           
 Boolean getActive()
           
 String getActualApplicationId()
           
 String getActualNotificationFromAddress()
           
 DocumentTypePolicy getAllowSuperUserFinalApprovalPolicy()
          Returns the ALLOW_SU_FINAL_APPROVAL policy on the document if defined, or the default value for this policy which is true.
 DocumentTypePolicy getAllowUnrequestedActionPolicy()
           
 String getAllowUnrequestedActionPolicyDisplayValue()
           
 String getApplicationId()
          Returns the application id for this DocumentType which can be specified on the document type itself, inherited from the parent, or defaulted to the configured application id of the application.
protected  String getApplicationId(boolean forDisplayPurposes)
          This method gets the string for the application id value.
 List<ApplicationDocumentStatusCategory> getApplicationStatusCategories()
          Get the application document status categories for this document type
 Boolean getApplyRetroactively()
           
 ObjectDefinition getAttributeObjectDefinition(RuleAttribute ruleAttribute)
           
 ObjectDefinition getAttributeObjectDefinition(String typeCode)
           
 String getAuthorizer()
           
 String getBlanketApproveGroupId()
           
 String getBlanketApprovePolicy()
           
 Group getBlanketApproveWorkgroup()
           
 String getBlanketApproveWorkgroupId()
           
 Group getBlanketApproveWorkgroupWithInheritance()
           
 Collection getChildrenDocTypes()
           
 Boolean getCurrentInd()
           
 CustomActionListAttribute getCustomActionListAttribute()
           
 RuleAttribute getCustomActionListRuleAttribute()
          Returns the RuleAttribute for the action list attribute for this DocumentType.
 CustomEmailAttribute getCustomEmailAttribute()
           
 String getCustomEmailStylesheet()
          Gets the name of the custom email stylesheet to use to render email (if any has been set, null otherwise)
 DocumentTypeAttributeBo getCustomizerAttribute()
           
 CustomNoteAttribute getCustomNoteAttribute()
           
 DocumentTypePolicy getDefaultApprovePolicy()
           
 String getDefaultApprovePolicyDisplayValue()
           
 Group getDefaultExceptionWorkgroup()
           
 String getDescription()
           
 String getDisplayableApplicationId()
          Returns the same value as the getApplicationId() method but will also have label information about where the application id came from (ie: inherited from the parent document type)
 String getDisplayableNotificationFromAddress()
          Returns the same value as the getNotificationFromAddress() method but will also have label information if the value is inherited from a parent document type
 String getDisplayablePostProcessorName()
           
 String getDisplayableUnresolvedDocHandlerUrl()
          Returns the same value as the 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
 String getDocSearchHelpUrl()
          This method gets the doc search help url from this object and resolves any potential variables that may be in use
 String getDocTypeActiveIndicatorDisplayValue()
           
 String getDocTypeParentId()
           
 String getDocumentId()
           
 DocumentTypePolicy getDocumentStatusPolicy()
          This method returns a DocumentTypePolicy object related to the DocumentStatusPolicy defined for this document type.
 DocumentTypeAttributeBo getDocumentTypeAttribute(int index)
           
 List<DocumentTypeAttributeBo> getDocumentTypeAttributes()
           
 List<DocumentTypeAttributeBo> getDocumentTypeAttributes(String... attributeTypes)
           
 String getDocumentTypeId()
           
 Collection<DocumentTypePolicy> getDocumentTypePolicies()
           
 DocumentTypeSecurity getDocumentTypeSecurity()
           
 String getDocumentTypeSecurityXml()
           
 Integer getDocumentTypeVersion()
           
 DocumentTypePolicy getEnrouteErrorSuppression()
           
 DocumentTypePolicy getFailOnInactiveGroup()
           
 String getHelpDefinitionUrl()
          This method gets the help definition url from this object and resolves any potential variables that may be in use
 String getId()
          The unique identifier for an object.
protected  String getInheritedPostProcessorName(boolean forDisplayPurposes)
          This method gets the post processor class value.
 DocumentTypePolicy getInitiatorMustBlanketApprovePolicy()
           
 DocumentTypePolicy getInitiatorMustCancelPolicy()
           
 String getInitiatorMustRouteDisplayValue()
           
 DocumentTypePolicy getInitiatorMustRoutePolicy()
           
 String getInitiatorMustSaveDisplayValue()
           
 DocumentTypePolicy getInitiatorMustSavePolicy()
           
 String getLabel()
           
 DocumentTypePolicy getLookIntoFuturePolicy()
           
 String getLookupParentName()
          this exists because the lookup wants to make a call on a bean method when displaying results and those calls are entered programatically into the framework by method name
 String getName()
           
 ProcessDefinitionBo getNamedProcess(String name)
           
 String getNotificationFromAddress()
           
protected  String getNotificationFromAddress(boolean forDisplayPurposes)
          This method gets the notification from address value.
 DocumentTypePolicy getNotifyOnSavePolicy()
           
 ObjectDefinition getObjectDefinition(String objectName)
           
 DocumentType getParentDocType()
           
 String getParentId()
           
 Map<DocumentTypePolicy,String> getPolicies()
           
 DocumentTypePolicy getPolicyByName(String policyName, Boolean defaultValue)
          Returns the policy value of the specified policy, consulting parent document type definitions if not defined on the immediate DocumentType.
 DocumentTypePolicy getPolicyByName(String policyName, String defaultValue)
          Returns the policy value of the specified policy, consulting parent document type definitions if not defined on the immediate DocumentType.
 PostProcessor getPostProcessor()
           
 String getPostProcessorName()
           
 DocumentType getPreviousVersion()
           
 String getPreviousVersionId()
           
 ProcessDefinitionBo getPrimaryProcess()
           
 List getProcesses()
          Gets the processes of this document by checking locally for processes, and if none are present, retrieves them from it's parent document type.
 DocumentTypePolicy getRecallNotification()
          Returns the RECALL_NOTIFICATION policy on the document if defined, or the default value for this policy which is true.
 DocumentTypePolicy getRegenerateActionRequestsOnChange()
           
 Group getReportingWorkgroup()
           
 String getReportingWorkgroupId()
           
 String getResolvedDocumentHandlerUrl()
          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
 String getReturnUrl()
           
 DocumentType getRouteDefiningDocumentType()
          Returns the DocumentType which defines the route for this document.
 List getRouteLevels()
           
 String getRoutingVersion()
           
 List<DocumentTypeAttributeBo> getSearchableAttributes()
           
 DocumentTypePolicy getSuperUserApproveNotificationPolicy()
           
 String getSuperUserGroupId()
           
 Group getSuperUserWorkgroup()
           
 Group getSuperUserWorkgroupNoInheritence()
           
 DocumentTypePolicy getSuPostprocessorOverridePolicy()
          This method returns a DocumentTypePolicy object related to the DocumentStatusPolicy defined for this document type.
 DocumentTypePolicy getSupportsQuickInitiatePolicy()
           
 DocumentTypePolicy getSuppressImmediateEmailsOnSuActionPolicy()
          Returns the SUPPRESS_IMMEDIATE_EMAILS_ON_SU_ACTION policy on the document if defined, or the default value for this policy which is false.
 String getUnresolvedDocHandlerUrl()
           
 String getUnresolvedDocSearchHelpUrl()
           
 String getUnresolvedHelpDefinitionUrl()
           
protected  String getUnresolvedInheritedDocHandlerUrl(boolean forDisplayPurposes)
          This method retrieves the unresolved document handler URL either from this object or from a parent document type object.
 DocumentTypePolicy getUseWorkflowSuperUserDocHandlerUrl()
           
 String getUseWorkflowSuperUserDocHandlerUrlValue()
           
 List<ApplicationDocumentStatus> getValidApplicationStatuses()
           
 Integer getVersion()
           
 boolean hasPreviousVersion()
           
 boolean hasSearchableAttributes()
           
 boolean isActive()
          The active indicator for an object.
 Boolean isAppDocStatusInUse()
          This method returns a boolean denoting whether the Application Document Status is to be used for this document type.
 boolean isBlanketApproveGroupDefined()
          Returns true if either a blanket approve group or blanket approve policy is defined on this Document Type.
 boolean isBlanketApprover(String principalId)
           
 boolean isCurrent()
           
 boolean isDocTypeActive()
           
 Boolean isKEWStatusInUse()
          This method returns a boolean denoting whether the KEW Route Status is to be displayed.
 boolean isParentOf(DocumentType documentType)
           
 boolean isPolicyDefined(DocumentTypePolicy policyToCheck)
           
 boolean isRouteInherited()
          Returns true if this document type defines it's own routing, false if it inherits its routing from a parent document type.
 boolean isSuperUser(String principalId)
           
 boolean isSuperUserGroupDefined()
          Returns true if this DocumentType has a super user group defined.
 List<DocumentType.ExtensionHolder<SearchableAttribute>> loadSearchableAttributes()
           
 void populateDataDictionaryEditableFields(Set<String> propertyNamesEditableViaUI, DocumentType dataDictionaryEditedType)
           
protected  String resolveDocHandlerUrl(String docHandlerUrl)
          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 resolveHelpUrl(String helpDefinitionUrl)
          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.
 void setActionsUrl(String actions)
           
 void setActive(boolean active)
          Sets the record to active or inactive.
 void setActive(Boolean activeInd)
           
 void setActualApplicationId(String actualApplicationId)
           
 void setActualNotificationFromAddress(String actualNotificationFromAddress)
           
 void setApplicationStatusCategories(List<ApplicationDocumentStatusCategory> applicationStatusCategories)
          Set the application document status categories for this document type
 void setApplyRetroactively(Boolean applyRetroactively)
           
 void setAuthorizer(String authorizer)
           
 void setBlanketApprovePolicy(String blanketApprovePolicy)
           
 void setBlanketApproveWorkgroup(Group blanketApproveWorkgroup)
           
 void setBlanketApproveWorkgroupId(String blanketApproveWorkgroupId)
           
 void setCurrentInd(Boolean currentInd)
           
 void setCustomEmailStylesheet(String customEmailStylesheet)
          Sets the name of the custom email stylesheet to use to render email
 void setDefaultExceptionWorkgroup(Group defaultExceptionWorkgroup)
           
 void setDescription(String description)
           
 void setDisplayableNotificationFromAddress(String displayableNotificationFromAddress)
          Deprecated.  
 void setDisplayablePostProcessorName(String displayablePostProcessorName)
          Deprecated.  
 void setDisplayableUnresolvedDocHandlerUrl(String displayableUnresolvedDocHandlerUrl)
          Deprecated.  
 void setDocHandlerUrl(String docHandlerUrl)
          Deprecated.  
 void setDocTypeParentId(String docTypeParentId)
           
 void setDocumentId(String documentId)
           
 void setDocumentTypeAttribute(int index, DocumentTypeAttributeBo documentTypeAttribute)
           
 void setDocumentTypeAttributes(List<DocumentTypeAttributeBo> documentTypeAttributes)
           
 void setDocumentTypeId(String docTypeGrpId)
           
 void setDocumentTypePolicies(Collection<DocumentTypePolicy> policies)
           
 void setDocumentTypeSecurityXml(String documentTypeSecurityXml)
           
 void setLabel(String label)
           
 void setName(String name)
           
 void setNotificationFromAddress(String notificationFromAddress)
          Deprecated.  
 void setPostProcessorName(String postProcessorName)
           
 void setPreviousVersionId(String previousVersionId)
           
 void setProcesses(List routeNodes)
           
 void setReportingWorkgroup(Group reportingWorkgroup)
           
 void setReportingWorkgroupId(String reportingWorkgroupId)
           
 void setReturnUrl(String returnUrl)
           
 void setRouteLevels(List routeLevels)
           
 void setRoutingVersion(String routingVersion)
           
 void setSuperUserWorkgroupIdNoInheritence(String suWorkgroupId)
          Set the immediate super user workgroup id field
 void setSuperUserWorkgroupNoInheritence(Group suWorkgroup)
           
 void setUnresolvedDocHandlerUrl(String unresolvedDocHandlerUrl)
           
 void setUnresolvedDocSearchHelpUrl(String unresolvedDocSearchHelpUrl)
           
 void setUnresolvedHelpDefinitionUrl(String unresolvedHelpDefinitionUrl)
           
 void setValidApplicationStatuses(List<ApplicationDocumentStatus> validApplicationStatuses)
           
 void setVersion(Integer version)
           
static DocumentType to(DocumentType documentTypeBo)
           
 
Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber
 
Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject
refresh
 
Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic
toString
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned
getVersionNumber
 

Constructor Detail

DocumentType

public DocumentType()
Method Detail

populateDataDictionaryEditableFields

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

getAllowUnrequestedActionPolicy

public DocumentTypePolicy getAllowUnrequestedActionPolicy()

getDefaultApprovePolicy

public DocumentTypePolicy getDefaultApprovePolicy()

getUseWorkflowSuperUserDocHandlerUrl

public DocumentTypePolicy getUseWorkflowSuperUserDocHandlerUrl()

getInitiatorMustRoutePolicy

public DocumentTypePolicy getInitiatorMustRoutePolicy()

getInitiatorMustSavePolicy

public DocumentTypePolicy getInitiatorMustSavePolicy()

getInitiatorMustCancelPolicy

public DocumentTypePolicy getInitiatorMustCancelPolicy()

getInitiatorMustBlanketApprovePolicy

public DocumentTypePolicy getInitiatorMustBlanketApprovePolicy()

getLookIntoFuturePolicy

public DocumentTypePolicy getLookIntoFuturePolicy()

getSuperUserApproveNotificationPolicy

public DocumentTypePolicy getSuperUserApproveNotificationPolicy()

getSupportsQuickInitiatePolicy

public DocumentTypePolicy getSupportsQuickInitiatePolicy()

getNotifyOnSavePolicy

public DocumentTypePolicy getNotifyOnSavePolicy()

getDocumentStatusPolicy

public DocumentTypePolicy getDocumentStatusPolicy()
This method returns a DocumentTypePolicy object related to the DocumentStatusPolicy defined for this document type.


getSuPostprocessorOverridePolicy

public DocumentTypePolicy getSuPostprocessorOverridePolicy()
This method returns a DocumentTypePolicy object related to the DocumentStatusPolicy defined for this document type.


getFailOnInactiveGroup

public DocumentTypePolicy getFailOnInactiveGroup()

getEnrouteErrorSuppression

public DocumentTypePolicy getEnrouteErrorSuppression()

getRegenerateActionRequestsOnChange

public DocumentTypePolicy getRegenerateActionRequestsOnChange()

getRecallNotification

public DocumentTypePolicy getRecallNotification()
Returns the RECALL_NOTIFICATION policy on the document if defined, or the default value for this policy which is true.

Returns:
the RECALL_NOTIFICATION document type policy
Since:
2.1

getSuppressImmediateEmailsOnSuActionPolicy

public DocumentTypePolicy getSuppressImmediateEmailsOnSuActionPolicy()
Returns the SUPPRESS_IMMEDIATE_EMAILS_ON_SU_ACTION policy on the document if defined, or the default value for this policy which is false.

Returns:
the SUPPRESS_IMMEDIATE_EMAILS_ON_SU_ACTION document type policy
Since:
2.1.3

getAllowSuperUserFinalApprovalPolicy

public DocumentTypePolicy getAllowSuperUserFinalApprovalPolicy()
Returns the ALLOW_SU_FINAL_APPROVAL policy on the document if defined, or the default value for this policy which is true.

Returns:
the ALLOW_SU_FINAL_APPROVAL document type policy
Since:
2.1.3

isKEWStatusInUse

public Boolean isKEWStatusInUse()
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.

Returns:
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

isAppDocStatusInUse

public Boolean isAppDocStatusInUse()
This method returns a boolean denoting whether the Application Document Status is to be used for this document type.

Returns:
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)

areBothStatusesInUse

public Boolean areBothStatusesInUse()
This method returns a boolean denoting if both the KEW Route Status and the Application Document Status are to be used in displays.

Returns:
true - if both the KEW Route Status and Application Document Status are to be displayed. false - if only one status is to be displayed.

getUseWorkflowSuperUserDocHandlerUrlValue

public String getUseWorkflowSuperUserDocHandlerUrlValue()

getAllowUnrequestedActionPolicyDisplayValue

public String getAllowUnrequestedActionPolicyDisplayValue()

getDefaultApprovePolicyDisplayValue

public String getDefaultApprovePolicyDisplayValue()

getInitiatorMustRouteDisplayValue

public String getInitiatorMustRouteDisplayValue()

getInitiatorMustSaveDisplayValue

public String getInitiatorMustSaveDisplayValue()

isPolicyDefined

public boolean isPolicyDefined(DocumentTypePolicy policyToCheck)

getDocumentTypeAttributes

public List<DocumentTypeAttributeBo> getDocumentTypeAttributes(String... attributeTypes)

hasSearchableAttributes

public boolean hasSearchableAttributes()

getSearchableAttributes

public List<DocumentTypeAttributeBo> getSearchableAttributes()

getCustomizerAttribute

public DocumentTypeAttributeBo getCustomizerAttribute()

getCustomActionListRuleAttribute

public RuleAttribute getCustomActionListRuleAttribute()
Returns the RuleAttribute for the action list attribute for this DocumentType. Walks the document type hierarchy if none exists directly on this DocumentType.

Returns:
The RuleAttribute. May be null.

loadSearchableAttributes

public List<DocumentType.ExtensionHolder<SearchableAttribute>> loadSearchableAttributes()

getDocumentTypeAttribute

public DocumentTypeAttributeBo getDocumentTypeAttribute(int index)

setDocumentTypeAttribute

public void setDocumentTypeAttribute(int index,
                                     DocumentTypeAttributeBo documentTypeAttribute)

getDocTypeActiveIndicatorDisplayValue

public String getDocTypeActiveIndicatorDisplayValue()

getChildrenDocTypes

public Collection getChildrenDocTypes()

getDocTypeParentId

public String getDocTypeParentId()
Specified by:
getDocTypeParentId in interface DocumentTypeEBO

setDocTypeParentId

public void setDocTypeParentId(String docTypeParentId)

getParentDocType

public DocumentType getParentDocType()

getDocumentTypePolicies

public Collection<DocumentTypePolicy> getDocumentTypePolicies()

setDocumentTypePolicies

public void setDocumentTypePolicies(Collection<DocumentTypePolicy> policies)

getPolicies

public Map<DocumentTypePolicy,String> getPolicies()
Specified by:
getPolicies in interface DocumentTypeContract

getValidApplicationStatuses

public List<ApplicationDocumentStatus> getValidApplicationStatuses()

setValidApplicationStatuses

public void setValidApplicationStatuses(List<ApplicationDocumentStatus> validApplicationStatuses)

getApplicationStatusCategories

public List<ApplicationDocumentStatusCategory> getApplicationStatusCategories()
Get the application document status categories for this document type

Returns:
the application document status categories for this document type
See Also:
ApplicationDocumentStatusCategory

setApplicationStatusCategories

public void setApplicationStatusCategories(List<ApplicationDocumentStatusCategory> applicationStatusCategories)
Set the application document status categories for this document type

Parameters:
applicationStatusCategories -

getDocumentTypeSecurityXml

public String getDocumentTypeSecurityXml()

setDocumentTypeSecurityXml

public void setDocumentTypeSecurityXml(String documentTypeSecurityXml)

getDocumentTypeSecurity

public DocumentTypeSecurity getDocumentTypeSecurity()

getRouteLevels

public List getRouteLevels()

setRouteLevels

public void setRouteLevels(List routeLevels)

getActionsUrl

public String getActionsUrl()

setActionsUrl

public void setActionsUrl(String actions)

getActive

public Boolean getActive()

setActive

public void setActive(Boolean activeInd)

getCurrentInd

public Boolean getCurrentInd()

isCurrent

public boolean isCurrent()
Specified by:
isCurrent in interface DocumentTypeContract

setCurrentInd

public void setCurrentInd(Boolean currentInd)

getDescription

public String getDescription()
Specified by:
getDescription in interface DocumentTypeContract
Specified by:
getDescription in interface DocumentTypeEBO

setDescription

public void setDescription(String description)

getResolvedDocumentHandlerUrl

public String getResolvedDocumentHandlerUrl()
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

Specified by:
getResolvedDocumentHandlerUrl in interface DocumentTypeContract

getUnresolvedInheritedDocHandlerUrl

protected String getUnresolvedInheritedDocHandlerUrl(boolean forDisplayPurposes)
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 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.

Parameters:
forDisplayPurposes - - if true then the string returned will have a label explaining where the value came from
Returns:
the unresolved document handler URL value or a displayable value with sourcing information

getDisplayableUnresolvedDocHandlerUrl

public String getDisplayableUnresolvedDocHandlerUrl()
Returns the same value as the 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


setDisplayableUnresolvedDocHandlerUrl

public void setDisplayableUnresolvedDocHandlerUrl(String displayableUnresolvedDocHandlerUrl)
Deprecated. 

EMPTY METHOD. Use setUnresolvedDocHandlerUrl(String) instead.


getUnresolvedDocHandlerUrl

public String getUnresolvedDocHandlerUrl()
Specified by:
getUnresolvedDocHandlerUrl in interface DocumentTypeContract
Returns:
the unresolvedDocHandlerUrl

setUnresolvedDocHandlerUrl

public void setUnresolvedDocHandlerUrl(String unresolvedDocHandlerUrl)
Parameters:
unresolvedDocHandlerUrl - the unresolvedDocHandlerUrl to set

resolveDocHandlerUrl

protected String resolveDocHandlerUrl(String docHandlerUrl)
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.


setDocHandlerUrl

public void setDocHandlerUrl(String docHandlerUrl)
Deprecated. 

Use setDocHandlerUrl(String) to add a document handler url to this object.


getUnresolvedHelpDefinitionUrl

public String getUnresolvedHelpDefinitionUrl()
Returns:
the unresolvedHelpDefinitionUrl

setUnresolvedHelpDefinitionUrl

public void setUnresolvedHelpDefinitionUrl(String unresolvedHelpDefinitionUrl)
Parameters:
unresolvedHelpDefinitionUrl - the unresolvedHelpDefinitionUrl to set

getHelpDefinitionUrl

public String getHelpDefinitionUrl()
This method gets the help definition url from this object and resolves any potential variables that may be in use

Specified by:
getHelpDefinitionUrl in interface DocumentTypeContract
Specified by:
getHelpDefinitionUrl in interface DocumentTypeEBO

resolveHelpUrl

protected String resolveHelpUrl(String helpDefinitionUrl)
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.


getUnresolvedDocSearchHelpUrl

public String getUnresolvedDocSearchHelpUrl()
Returns:
the unresolvedDocSearchHelpUrl

setUnresolvedDocSearchHelpUrl

public void setUnresolvedDocSearchHelpUrl(String unresolvedDocSearchHelpUrl)
Parameters:
unresolvedDocSearchHelpUrl - the unresolvedDocSearchHelpUrl to set

getDocSearchHelpUrl

public String getDocSearchHelpUrl()
This method gets the doc search help url from this object and resolves any potential variables that may be in use

Specified by:
getDocSearchHelpUrl in interface DocumentTypeContract

getLabel

public String getLabel()
Specified by:
getLabel in interface DocumentTypeContract
Specified by:
getLabel in interface DocumentTypeEBO

setLabel

public void setLabel(String label)

getName

public String getName()
Specified by:
getName in interface DocumentTypeContract
Specified by:
getName in interface DocumentTypeEBO

setName

public void setName(String name)

getPostProcessor

public PostProcessor getPostProcessor()

getInheritedPostProcessorName

protected String getInheritedPostProcessorName(boolean forDisplayPurposes)
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 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.

Parameters:
forDisplayPurposes - - if true then the string returned will have a label explaining where the value came from
Returns:
the post processor class value or a displayable value with sourcing information

getPostProcessorName

public String getPostProcessorName()
Specified by:
getPostProcessorName in interface DocumentTypeContract

setPostProcessorName

public void setPostProcessorName(String postProcessorName)

getDisplayablePostProcessorName

public String getDisplayablePostProcessorName()

setDisplayablePostProcessorName

public void setDisplayablePostProcessorName(String displayablePostProcessorName)
Deprecated. 

EMPTY METHOD. Use setPostProcessorName(String) instead.


getPreviousVersionId

public String getPreviousVersionId()

setPreviousVersionId

public void setPreviousVersionId(String previousVersionId)

getDocumentId

public String getDocumentId()

setDocumentId

public void setDocumentId(String documentId)

getVersion

public Integer getVersion()

setVersion

public void setVersion(Integer version)

getDocumentTypeId

public String getDocumentTypeId()
Specified by:
getDocumentTypeId in interface DocumentTypeEBO

setDocumentTypeId

public void setDocumentTypeId(String docTypeGrpId)

getId

public String getId()
Description copied from interface: Identifiable
The unique identifier for an object. This can be null.

Specified by:
getId in interface Identifiable
Returns:
the id

copy

public Object copy(boolean preserveKeys)

getReturnUrl

public String getReturnUrl()

setReturnUrl

public void setReturnUrl(String returnUrl)

getPolicyByName

public DocumentTypePolicy getPolicyByName(String policyName,
                                          Boolean defaultValue)
Returns the policy value of the specified policy, consulting parent document type definitions if not defined on the immediate DocumentType. If not found, a policy with the specified default value is returned. If policy is found on parent but boolean value is undefined, TRUE is used.

Parameters:
policyName - the policy name to look up
defaultValue - the default boolean value to return if policy is not found
Returns:
DocumenTypePolicy defined on immediate or parent document types, or new instance initialized with specified default boolean value

getPolicyByName

public DocumentTypePolicy getPolicyByName(String policyName,
                                          String defaultValue)
Returns the policy value of the specified policy, consulting parent document type definitions if not defined on the immediate DocumentType. If not found, a policy with a boolean value of True and a string value of the specified default value is returned. If policy is found on parent but boolean value is undefined, TRUE is used.

Parameters:
policyName - the policy name to look up
defaultValue - the default string value to return if policy is not found
Returns:
DocumenTypePolicy defined on immediate or parent document types, or new instance initialized with specified default string value

getSuperUserWorkgroup

public Group getSuperUserWorkgroup()

getSuperUserWorkgroupNoInheritence

public Group getSuperUserWorkgroupNoInheritence()

setSuperUserWorkgroupNoInheritence

public void setSuperUserWorkgroupNoInheritence(Group suWorkgroup)

setSuperUserWorkgroupIdNoInheritence

public void setSuperUserWorkgroupIdNoInheritence(String suWorkgroupId)
Set the immediate super user workgroup id field

Parameters:
suWorkgroupId - the super user workgroup id

isSuperUserGroupDefined

public boolean isSuperUserGroupDefined()
Returns true if this DocumentType has a super user group defined.


getPreviousVersion

public DocumentType getPreviousVersion()

getBlanketApproveWorkgroup

public Group getBlanketApproveWorkgroup()

setBlanketApproveWorkgroup

public void setBlanketApproveWorkgroup(Group blanketApproveWorkgroup)

getBlanketApprovePolicy

public String getBlanketApprovePolicy()

setBlanketApprovePolicy

public void setBlanketApprovePolicy(String blanketApprovePolicy)

getBlanketApproveWorkgroupWithInheritance

public Group getBlanketApproveWorkgroupWithInheritance()

isBlanketApprover

public boolean isBlanketApprover(String principalId)

isBlanketApproveGroupDefined

public boolean isBlanketApproveGroupDefined()
Returns true if either a blanket approve group or blanket approve policy is defined on this Document Type.


getReportingWorkgroupId

public String getReportingWorkgroupId()
Returns:
the reportingWorkgroupId

setReportingWorkgroupId

public void setReportingWorkgroupId(String reportingWorkgroupId)
Parameters:
reportingWorkgroupId - the reportingWorkgroupId to set

getReportingWorkgroup

public Group getReportingWorkgroup()

setReportingWorkgroup

public void setReportingWorkgroup(Group reportingWorkgroup)

getDefaultExceptionWorkgroup

public Group getDefaultExceptionWorkgroup()

setDefaultExceptionWorkgroup

public void setDefaultExceptionWorkgroup(Group defaultExceptionWorkgroup)

getCustomActionListAttribute

public CustomActionListAttribute getCustomActionListAttribute()
                                                       throws ResourceUnavailableException
Throws:
ResourceUnavailableException

getCustomEmailAttribute

public CustomEmailAttribute getCustomEmailAttribute()
                                             throws ResourceUnavailableException
Throws:
ResourceUnavailableException

getAttributeObjectDefinition

public ObjectDefinition getAttributeObjectDefinition(String typeCode)

getAttributeObjectDefinition

public ObjectDefinition getAttributeObjectDefinition(RuleAttribute ruleAttribute)

getCustomNoteAttribute

public CustomNoteAttribute getCustomNoteAttribute()
                                           throws ResourceUnavailableException
Throws:
ResourceUnavailableException

getObjectDefinition

public ObjectDefinition getObjectDefinition(String objectName)

isRouteInherited

public boolean isRouteInherited()
Returns true if this document type defines it's own routing, false if it inherits its routing from a parent document type.


getRouteDefiningDocumentType

public DocumentType getRouteDefiningDocumentType()
Returns the DocumentType which defines the route for this document. This is the DocumentType from which we inherit our Processes which define our routing.


isDocTypeActive

public boolean isDocTypeActive()

setDocumentTypeAttributes

public void setDocumentTypeAttributes(List<DocumentTypeAttributeBo> documentTypeAttributes)
Parameters:
documentTypeAttributes - The documentTypeAttributes to set.

getDocumentTypeAttributes

public List<DocumentTypeAttributeBo> getDocumentTypeAttributes()
Specified by:
getDocumentTypeAttributes in interface DocumentTypeContract
Returns:
Returns the documentTypeAttributes.

addProcess

public void addProcess(ProcessDefinitionBo process)

getProcesses

public List getProcesses()
Gets the processes of this document by checking locally for processes, and if none are present, retrieves them from it's parent document type. The list returned is an immutable list. To add processes to a document type, use the addProcess method.

NOTE: Since OJB uses direct field access, this will not interfere with the proper mapping of the processes field.

Returns:

setProcesses

public void setProcesses(List routeNodes)

getPrimaryProcess

public ProcessDefinitionBo getPrimaryProcess()

getNamedProcess

public ProcessDefinitionBo getNamedProcess(String name)

getRoutingVersion

public String getRoutingVersion()

setRoutingVersion

public void setRoutingVersion(String routingVersion)

getActualNotificationFromAddress

public String getActualNotificationFromAddress()
Returns:
the actualNotificationFromAddress

setActualNotificationFromAddress

public void setActualNotificationFromAddress(String actualNotificationFromAddress)
Parameters:
actualNotificationFromAddress - the actualNotificationFromAddress to set

getDisplayableNotificationFromAddress

public String getDisplayableNotificationFromAddress()
Returns the same value as the getNotificationFromAddress() method but will also have label information if the value is inherited from a parent document type


setDisplayableNotificationFromAddress

public void setDisplayableNotificationFromAddress(String displayableNotificationFromAddress)
Deprecated. 

EMPTY METHOD. Use setActualNotificationFromAddress(String) instead.


getNotificationFromAddress

public String getNotificationFromAddress()

getNotificationFromAddress

protected String getNotificationFromAddress(boolean forDisplayPurposes)
This method gets the notification from address value. If the forDisplayPurposes value is true the notification from address value will be invalid for system use

This method will first call the getActualNotificationFromAddress() 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

Parameters:
forDisplayPurposes - - if true then the string returned will have a label explaining where the value came from
Returns:
the notification from address value or a displayable value with sourcing information

setNotificationFromAddress

public void setNotificationFromAddress(String notificationFromAddress)
Deprecated. 

Use setActualNotificationFromAddress(String) instead


isParentOf

public boolean isParentOf(DocumentType documentType)

getLookupParentName

public String getLookupParentName()
this exists because the lookup wants to make a call on a bean method when displaying results and those calls are entered programatically into the framework by method name

Returns:

isSuperUser

public boolean isSuperUser(String principalId)

hasPreviousVersion

public boolean hasPreviousVersion()

getActualApplicationId

public String getActualApplicationId()
Returns:
the actual application id

setActualApplicationId

public void setActualApplicationId(String actualApplicationId)
Parameters:
actualApplicationId - the actualApplicationId to set

getApplicationId

public String getApplicationId()
Returns the application id for this DocumentType which can be specified on the document type itself, inherited from the parent, or defaulted to the configured application id of the application.

Specified by:
getApplicationId in interface DocumentTypeContract
Specified by:
getApplicationId in interface DocumentTypeEBO

getApplicationId

protected String getApplicationId(boolean forDisplayPurposes)
This method gets the string for the application id value. If the forDisplayPurposes value is true the application id value will be invalid for system use.

This method will first call the getActualApplicationId() method to check for a value on this object. If none is found a parent document type is used. 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 for this object the system default is used: CoreConfigHelper.getApplicationId()

Parameters:
forDisplayPurposes - - if true then the string returned will have a label explaining where the value came from
Returns:
the application id value or a displayable value with sourcing information

getDisplayableApplicationId

public String getDisplayableApplicationId()
Returns the same value as the getApplicationId() method but will also have label information about where the application id came from (ie: inherited from the parent document type)


getCustomEmailStylesheet

public String getCustomEmailStylesheet()
Gets the name of the custom email stylesheet to use to render email (if any has been set, null otherwise)

Returns:
name of the custom email stylesheet to use to render email (if any has been set, null otherwise)

setCustomEmailStylesheet

public void setCustomEmailStylesheet(String customEmailStylesheet)
Sets the name of the custom email stylesheet to use to render email


getBlanketApproveWorkgroupId

public String getBlanketApproveWorkgroupId()
Returns:
the blanketApproveWorkgroupId

setBlanketApproveWorkgroupId

public void setBlanketApproveWorkgroupId(String blanketApproveWorkgroupId)
Parameters:
blanketApproveWorkgroupId - the blanketApproveWorkgroupId to set

getApplyRetroactively

public Boolean getApplyRetroactively()
Returns:
the applyRetroactively

setApplyRetroactively

public void setApplyRetroactively(Boolean applyRetroactively)
Parameters:
applyRetroactively - the applyRetroactively to set

isActive

public boolean isActive()
Description copied from interface: Inactivatable
The active indicator for an object.

Specified by:
isActive in interface Inactivatable
Specified by:
isActive in interface DocumentTypeContract
Specified by:
isActive in interface DocumentTypeEBO
Returns:
true if active false if not.
See Also:
Inactivatable.isActive()

setActive

public void setActive(boolean active)
Description copied from interface: MutableInactivatable
Sets the record to active or inactive.

Specified by:
setActive in interface MutableInactivatable
See Also:
MutableInactivatable.setActive(boolean)

getDocumentTypeVersion

public Integer getDocumentTypeVersion()
Specified by:
getDocumentTypeVersion in interface DocumentTypeContract

getParentId

public String getParentId()
Specified by:
getParentId in interface DocumentTypeContract

getBlanketApproveGroupId

public String getBlanketApproveGroupId()
Specified by:
getBlanketApproveGroupId in interface DocumentTypeContract

getSuperUserGroupId

public String getSuperUserGroupId()
Specified by:
getSuperUserGroupId in interface DocumentTypeContract

getAuthorizer

public String getAuthorizer()
Specified by:
getAuthorizer in interface DocumentTypeContract
Returns:
the custom DocumentTypePermissionService class or service name configured for the doc type

setAuthorizer

public void setAuthorizer(String authorizer)

to

public static DocumentType to(DocumentType documentTypeBo)

from

public static DocumentType from(DocumentTypeContract dt)


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