org.kuali.rice.kew.doctype.service

Interface DocumentTypeQueryService

All Superinterfaces:

XmlLoader

All Known Subinterfaces:

DocumentTypeService

All Known Implementing Classes:

DocumentTypeServiceImpl

public interface DocumentTypeQueryService
extends XmlLoader

A service for querying document type stuff for plugins without exposing the document type service.

Author:

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

Method Summary

Modifier and Type	Method and Description
Collection<DocumentType>	find(DocumentType documentType, String docGroupName, boolean climbHierarchy)
DocumentType	findByDocumentId(String documentId) Returns the DocumentType of the Document with the given ID.
DocumentType	findById(String documentTypeId)
DocumentType	findByName(String name)
String	findParentNameByName(String documentTypeName) Returns the name fo the parent document type for the document type with the given name, or null if the specified document type doesn't have a parent document type.
DocumentType	findRootDocumentType(DocumentType docType)

Methods inherited from interface org.kuali.rice.core.framework.impex.xml.XmlLoader

loadXml

Method Detail

findById

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'{BO}\' + \'documentTypeId=\' + #p0")
DocumentType findById(String documentTypeId)

findByName

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'{BO}\' + \'name=\' + #p0")
DocumentType findByName(String name)

find

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'{BO}\' + \'documentTypeId=\' + #p0.getId() + \'|\' + \'name=\' + #p0.getName() + \'|\' + \'label=\' + #p0.getLabel() + \'|\' + \'active=\' + #p0.isActive() +\'docGroupName=\' + #p1 + \'|\' + \'climbHierarchy=\' + #p2")
Collection<DocumentType> find(DocumentType documentType,
                                                                                                                                                                                                                                                                                                                                               String docGroupName,
                                                                                                                                                                                                                                                                                                                                               boolean climbHierarchy)

findRootDocumentType

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'{BO}{root}\' + \'documentTypeId=\' + #p0.getId()")
DocumentType findRootDocumentType(DocumentType docType)

findByDocumentId

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'{BO}\' + \'documentId=\' + #p0")
DocumentType findByDocumentId(String documentId)

Returns the DocumentType of the Document with the given ID.

Since:

2.3

findParentNameByName

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'{BO}\' + \'parentOfName=\' + #p0")
String findParentNameByName(String documentTypeName)

Returns the name fo the parent document type for the document type with the given name, or null if the specified document type doesn't have a parent document type.

Parameters:

documentTypeName - the name of the document type for which to find the parent

Returns:

the name of the specified document types parent documenttype, or null if the document type is a root document type