Package org.kuali.rice.kew.api.doctype

Interface DocumentTypeService

public interface DocumentTypeService

TODO ...

Author:

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

Method Summary

Modifier and Type	Method	Description
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 Details

getIdByName

String getIdByName(String documentTypeName)
            throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

getNameById

String getNameById(String documentTypeId)
            throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

getDocumentTypeById

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

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

getDocumentTypeByName

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

Throws:

org.kuali.rice.core.api.exception.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 org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

isSuperUserForDocumentTypeName

boolean isSuperUserForDocumentTypeName(String principalId,
 String documentTypeName)
                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

canSuperUserApproveSingleActionRequest

boolean canSuperUserApproveSingleActionRequest(String principalId,
 String documentTypeName,
 List<RouteNodeInstance> routeNodeInstances,
 String routeStatusCode)
                                        throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

canSuperUserApproveDocument

boolean canSuperUserApproveDocument(String principalId,
 String documentTypeName,
 List<RouteNodeInstance> routeNodeInstances,
 String routeStatusCode)
                             throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

canSuperUserDisapproveDocument

boolean canSuperUserDisapproveDocument(String principalId,
 String documentTypeName,
 List<RouteNodeInstance> routeNodeInstances,
 String routeStatusCode)
                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

hasRouteNodeForDocumentTypeName

boolean hasRouteNodeForDocumentTypeName(String routeNodeName,
 String documentTypeName)
                                 throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

hasRouteNodeForDocumentTypeId

boolean hasRouteNodeForDocumentTypeId(String routeNodeName,
 String documentTypeId)
                               throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

isActiveById

boolean isActiveById(String documentTypeId)
              throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

isActiveByName

boolean isActiveByName(String documentTypeName)
                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

getRoutePathForDocumentTypeId

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

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

getRoutePathForDocumentTypeName

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

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException