org.kuali.rice.kew.api.doctype
Interface DocumentTypeService

All Known Implementing Classes:
DocumentTypeServiceImpl

public interface DocumentTypeService

TODO ...

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

Method Summary
 boolean canSuperUserApproveDocument(String principalId, String documentTypeName, List<RouteNodeInstance> routeNodeInstances, String routeStatusCode)
           
 boolean canSuperUserApproveSingleActionRequest(String principalId, String documentTypeName, List<RouteNodeInstance> routeNodeInstances, String routeStatusCode)
           
 boolean canSuperUserDisapproveDocument(String principalId, String documentTypeName, List<RouteNodeInstance> routeNodeInstances, String routeStatusCode)
           
 List<DocumentType> findAllDocumentTypes()
           
 DocumentType getDocumentTypeById(String documentTypeId)
           
 DocumentType getDocumentTypeByName(String documentTypeName)
           
 String getIdByName(String documentTypeName)
           
 String getNameById(String documentTypeId)
           
 RoutePath getRoutePathForDocumentTypeId(String documentTypeId)
           
 RoutePath getRoutePathForDocumentTypeName(String documentTypeName)
           
 boolean hasRouteNodeForDocumentTypeId(String routeNodeName, String documentTypeId)
           
 boolean hasRouteNodeForDocumentTypeName(String routeNodeName, String documentTypeName)
           
 boolean isActiveById(String documentTypeId)
           
 boolean isActiveByName(String documentTypeName)
           
 boolean isSuperUserForDocumentTypeId(String principalId, String documentTypeId)
           
 boolean isSuperUserForDocumentTypeName(String principalId, String documentTypeName)
           
 

Method Detail

getIdByName

String getIdByName(String documentTypeName)
                   throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

getNameById

String getNameById(String documentTypeId)
                   throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

getDocumentTypeById

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'documentTypeId=\' + #p0")
DocumentType getDocumentTypeById(String documentTypeId)
                                 throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

getDocumentTypeByName

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'documentTypeName=\' + #p0")
DocumentType getDocumentTypeByName(String documentTypeName)
                                   throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

findAllDocumentTypes

@Cacheable(value="http://rice.kuali.org/kew/v2_0/DocumentTypeType",
           key="\'all\'")
List<DocumentType> findAllDocumentTypes()

isSuperUserForDocumentTypeId

boolean isSuperUserForDocumentTypeId(String principalId,
                                     String documentTypeId)
                                     throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

isSuperUserForDocumentTypeName

boolean isSuperUserForDocumentTypeName(String principalId,
                                       String documentTypeName)
                                       throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

canSuperUserApproveSingleActionRequest

boolean canSuperUserApproveSingleActionRequest(String principalId,
                                               String documentTypeName,
                                               List<RouteNodeInstance> routeNodeInstances,
                                               String routeStatusCode)
                                               throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

canSuperUserApproveDocument

boolean canSuperUserApproveDocument(String principalId,
                                    String documentTypeName,
                                    List<RouteNodeInstance> routeNodeInstances,
                                    String routeStatusCode)
                                    throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

canSuperUserDisapproveDocument

boolean canSuperUserDisapproveDocument(String principalId,
                                       String documentTypeName,
                                       List<RouteNodeInstance> routeNodeInstances,
                                       String routeStatusCode)
                                       throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

hasRouteNodeForDocumentTypeName

boolean hasRouteNodeForDocumentTypeName(String routeNodeName,
                                        String documentTypeName)
                                        throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

hasRouteNodeForDocumentTypeId

boolean hasRouteNodeForDocumentTypeId(String routeNodeName,
                                      String documentTypeId)
                                      throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

isActiveById

boolean isActiveById(String documentTypeId)
                     throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

isActiveByName

boolean isActiveByName(String documentTypeName)
                       throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

getRoutePathForDocumentTypeId

@Cacheable(value="http://rice.kuali.org/kew/v2_0/RoutePathType",
           key="\'documentTypeId=\' + #p0")
RoutePath getRoutePathForDocumentTypeId(String documentTypeId)
                                        throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException

getRoutePathForDocumentTypeName

@Cacheable(value="http://rice.kuali.org/kew/v2_0/RoutePathType",
           key="\'documentTypeName=\' + #p0")
RoutePath getRoutePathForDocumentTypeName(String documentTypeName)
                                          throws RiceIllegalArgumentException
Throws:
RiceIllegalArgumentException


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