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

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.kew.api.doctype.DocumentType
All Implemented Interfaces:
Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, DocumentTypeContract

public final class DocumentType
extends AbstractDataTransferObject
implements DocumentTypeContract

See Also:
Serialized Form

Nested Class Summary
static class DocumentType.Builder
          A builder which can be used to construct DocumentType instances.
static class DocumentType.Cache
           
 
Method Summary
 String getApplicationId()
           
 String getAuthorizer()
           
 String getBlanketApproveGroupId()
           
 String getDescription()
           
 String getDocSearchHelpUrl()
           
 List<DocumentTypeAttribute> getDocumentTypeAttributes()
           
 Integer getDocumentTypeVersion()
           
 String getHelpDefinitionUrl()
           
 String getId()
          The unique identifier for an object.
 String getLabel()
           
 String getName()
           
 String getParentId()
           
 Map<DocumentTypePolicy,String> getPolicies()
           
 String getPostProcessorName()
           
 String getResolvedDocumentHandlerUrl()
           
 String getSuperUserGroupId()
           
 String getUnresolvedDocHandlerUrl()
           
 Long getVersionNumber()
          Returns the version number for this object.
 boolean isActive()
           
 boolean isCurrent()
           
 
Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

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

getName

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

getDocumentTypeVersion

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

getLabel

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

getDescription

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

getParentId

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

isActive

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

getUnresolvedDocHandlerUrl

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

getHelpDefinitionUrl

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

getDocSearchHelpUrl

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

getPostProcessorName

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

getApplicationId

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

isCurrent

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

getBlanketApproveGroupId

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

getSuperUserGroupId

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

getPolicies

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

getDocumentTypeAttributes

public List<DocumentTypeAttribute> getDocumentTypeAttributes()
Specified by:
getDocumentTypeAttributes in interface DocumentTypeContract

getVersionNumber

public Long getVersionNumber()
Description copied from interface: Versioned
Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:
getVersionNumber in interface Versioned
Returns:
the version number, or null if one has not been assigned yet

getResolvedDocumentHandlerUrl

public String getResolvedDocumentHandlerUrl()
Specified by:
getResolvedDocumentHandlerUrl 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
Since:
2.1.3


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