Package org.kuali.rice.kew.doctype.dao

Interface DocumentTypeDAO

All Known Implementing Classes:

DocumentTypeDAOJpa

public interface DocumentTypeDAO

Author:

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

Method Summary

Modifier and Type	Method	Description
Collection<DocumentType>	find(DocumentType documentType, DocumentType docTypeParentName, boolean climbHierarchy)	Find Document Types by document type and parent name
List	findAllCurrent()	Find all current document types
List	findAllCurrentByName(String name)	Find all current with name
DocumentType	findByName(String name)	Find Document Type by name (case sensitive by default)
DocumentType	findByName(String name, boolean caseSensitive)	Find Document Type by name
DocumentType	findDocumentTypeByDocumentId(String documentId)	Find Document Type by document id
String	findDocumentTypeIdByName(String documentTypeName)	Find document type id by name
String	findDocumentTypeNameById(String documentTypeId)	Find Document type name by id
List<String>	getChildDocumentTypeIds(String parentDocumentTypeId)	Get Child Document Type ids by parent id
Integer	getMaxVersionNumber(String docTypeName)	Get Max version number of document type
void	incrementOptimisticLock(String documentTypeId)	Increments the optimstic locking version number for the document type with the given id.

Method Details

findByName

DocumentType findByName(String name)

Find Document Type by name (case sensitive by default)

Parameters:

name -

Returns:

DocumentType or null

findByName

DocumentType findByName(String name,
 boolean caseSensitive)

Find Document Type by name

Parameters:

name -

caseSensitive -

Returns:

DocumentType or null

find

Collection<DocumentType> find(DocumentType documentType,
 DocumentType docTypeParentName,
 boolean climbHierarchy)

Find Document Types by document type and parent name

Parameters:

documentType -

docTypeParentName -

climbHierarchy -

Returns:

Collection of matching document types

getMaxVersionNumber

Integer getMaxVersionNumber(String docTypeName)

Get Max version number of document type

Parameters:

docTypeName -

Returns:

max version number

findAllCurrent

List findAllCurrent()

Find all current document types

Returns:

List of current DocumentTypes

findAllCurrentByName

List findAllCurrentByName(String name)

Find all current with name

Parameters:

name -

Returns:

List of Document Type by name

getChildDocumentTypeIds

List<String> getChildDocumentTypeIds(String parentDocumentTypeId)

Get Child Document Type ids by parent id

Parameters:

parentDocumentTypeId -

Returns:

List of child document type ids

findDocumentTypeIdByName

String findDocumentTypeIdByName(String documentTypeName)

Find document type id by name

Parameters:

documentTypeName -

Returns:

document type id

findDocumentTypeNameById

String findDocumentTypeNameById(String documentTypeId)

Find Document type name by id

Parameters:

documentTypeId -

Returns:

document type name

findDocumentTypeByDocumentId

DocumentType findDocumentTypeByDocumentId(String documentId)

Find Document Type by document id

Parameters:

documentId -

Returns:

DocumentType

incrementOptimisticLock

void incrementOptimisticLock(String documentTypeId)

Increments the optimstic locking version number for the document type with the given id.

Parameters:

documentTypeId - the id of the document type for which to increment the version number