org.kuali.rice.kew.dto
Class DTOConverter

java.lang.Object
  org.kuali.rice.kew.dto.DTOConverter

public class DTOConverter
extends Object

Translates Workflow server side beans into client side VO beans.

Author:

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

Nested Class Summary

static interface

DTOConverter.RouteNodeInstanceLoader Interface for a simple service providing RouteNodeInstanceS based on their IDs

Constructor Summary

DTOConverter()

Method Summary

static String	buildUpdatedDocumentContent(DocumentContentDTO documentContentVO) Converts the given DocumentContentVO to a document content string.
static ActionItemDTO	convertActionItem(ActionItem actionItem)
static ActionRequestDTO	convertActionRequest(ActionRequestValue actionRequest)
protected static ActionRequestDTO	convertActionRequest(ActionRequestValue actionRequest, boolean includeActionTaken)
static ActionRequestValue	convertActionRequestDTO(ActionRequestDTO actionRequestDTO) Converts an ActionRequestVO to an ActionRequest.
static ActionRequestValue	convertActionRequestDTO(ActionRequestDTO actionRequestDTO, DTOConverter.RouteNodeInstanceLoader routeNodeInstanceLoader) Converts an ActionRequestVO to an ActionRequest.
protected static ActionRequestValue	convertActionRequestVO(ActionRequestDTO actionRequestDTO, ActionRequestValue parentActionRequest, DTOConverter.RouteNodeInstanceLoader routeNodeInstanceLoader)
static ActionTakenDTO	convertActionTaken(ActionTakenValue actionTaken)
protected static ActionTakenDTO	convertActionTaken(ActionTakenValue actionTaken, boolean fetchActionRequests)
static ActionTakenEventDTO	convertActionTakenEvent(ActionTakenEvent actionTakenEvent)
static ActionTakenValue	convertActionTakenVO(ActionTakenDTO actionTakenVO)
static ActionTakenDTO	convertActionTakenWithActionRequests(ActionTakenValue actionTaken)
static AdHocRevoke	convertAdHocRevokeVO(AdHocRevokeDTO revokeVO)
static AfterProcessEventDTO	convertAfterProcessEvent(AfterProcessEvent event)
static BeforeProcessEventDTO	convertBeforeProcessEvent(BeforeProcessEvent event)
static DeleteEventDTO	convertDeleteEvent(DeleteEvent deleteEvent)
static DocumentContentDTO	convertDocumentContent(String documentContentValue, Long documentId)
static DocumentDetailDTO	convertDocumentDetail(DocumentRouteHeaderValue routeHeader)
static DocumentLinkDTO[]	convertDocumentLink(Collection<DocumentLink> links)
static DocumentLinkDTO	convertDocumentLink(DocumentLink link)
static List<DocumentLinkDTO>	convertDocumentLinkToArrayList(Collection<DocumentLink> links)
static DocumentLockingEventDTO	convertDocumentLockingEvent(DocumentLockingEvent event)
static DocumentRouteLevelChangeDTO	convertDocumentRouteLevelChange(DocumentRouteLevelChange routeLevelChange)
static DocumentRouteStatusChangeDTO	convertDocumentRouteStatusChange(DocumentRouteStatusChange statusChange)
static DocSearchCriteriaDTO	convertDocumentSearchCriteriaDTO(DocumentSearchCriteriaDTO criteriaVO)
static DocumentSearchResultRowDTO	convertDocumentSearchResult(DocumentSearchResult resultRow)
static DocumentSearchResultDTO	convertDocumentSearchResultComponents(DocumentSearchResultComponents searchResult)
static DocumentStatusTransitionDTO	convertDocumentStatusTransition(DocumentStatusTransition transition)
static DocumentTypeDTO	convertDocumentType(DocumentType docType)
static MovePoint	convertMovePointVO(MovePointDTO movePointVO)
static ProcessDTO	convertProcess(Process process)
static SimulationActionToTake	convertReportActionToTakeVO(ReportActionToTakeDTO actionToTakeVO)
static SimulationCriteria	convertReportCriteriaDTO(ReportCriteriaDTO criteriaVO)
static ResponsiblePartyDTO	convertResponsibleParty(ResponsibleParty responsibleParty)
static ResponsibleParty	convertResponsiblePartyVO(ResponsiblePartyDTO responsiblePartyVO)
static Recipient	convertResponsiblePartyVOtoRecipient(ResponsiblePartyDTO responsiblePartyVO) refactor name to convertResponsiblePartyVO when ResponsibleParty object is gone
static RouteHeaderDTO	convertRouteHeader(DocumentRouteHeaderValue routeHeader, String principalId)
static DocumentRouteHeaderValue	convertRouteHeaderVO(RouteHeaderDTO routeHeaderVO)
static RouteNodeDTO	convertRouteNode(RouteNode node)
static RouteNodeInstanceDTO	convertRouteNodeInstance(RouteNodeInstance nodeInstance)
static RoutePathDTO	convertRoutePath(DocumentType documentType)
static RuleDTO	convertRule(RuleBaseValues ruleValues)
static RuleDelegationDTO	convertRuleDelegation(RuleDelegation ruleDelegation)
static Collection<RuleExtensionDTO>	convertRuleExtension(RuleExtension ruleExtension)
static KeyValue	convertRuleExtensionVO(RuleExtensionDTO ruleExtensionVO)
static RuleResponsibilityDTO	convertRuleResponsibility(RuleResponsibility ruleResponsibility)
static StateDTO	convertState(State nodeState)
static StateDTO[]	convertStates(Collection states)
static ValidActionsDTO	convertValidActions(ValidActions validActions)
static AttributeDefinition	convertWorkflowAttributeDefinitionVO(WorkflowAttributeDefinitionDTO definitionVO, DocumentType documentType)
static WorkflowAttributeValidationErrorDTO	convertWorkflowAttributeValidationError(WorkflowAttributeValidationError error)
static void	updateNotes(RouteHeaderDTO routeHeaderVO, Long routeHeaderId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DTOConverter

public DTOConverter()

Method Detail

convertRouteHeader

public static RouteHeaderDTO convertRouteHeader(DocumentRouteHeaderValue routeHeader,
                                                String principalId)
                                         throws WorkflowException

Throws:

WorkflowException

convertValidActions

public static ValidActionsDTO convertValidActions(ValidActions validActions)

convertRouteHeaderVO

public static DocumentRouteHeaderValue convertRouteHeaderVO(RouteHeaderDTO routeHeaderVO)
                                                     throws WorkflowException

Throws:

WorkflowException

convertActionItem

public static ActionItemDTO convertActionItem(ActionItem actionItem)

buildUpdatedDocumentContent

public static String buildUpdatedDocumentContent(DocumentContentDTO documentContentVO)
                                          throws WorkflowException

Converts the given DocumentContentVO to a document content string. This method considers existing content on the document and updates approriately. The string returned will be the new document content for the document. If null is returned, then the document content is unchanged.

Throws:

WorkflowException

convertDocumentContent

public static DocumentContentDTO convertDocumentContent(String documentContentValue,
                                                        Long documentId)
                                                 throws WorkflowException

Throws:

WorkflowException

convertDocumentType

public static DocumentTypeDTO convertDocumentType(DocumentType docType)

convertRoutePath

public static RoutePathDTO convertRoutePath(DocumentType documentType)

convertActionRequest

public static ActionRequestDTO convertActionRequest(ActionRequestValue actionRequest)

convertActionRequest

protected static ActionRequestDTO convertActionRequest(ActionRequestValue actionRequest,
                                                       boolean includeActionTaken)

convertActionTakenWithActionRequests

public static ActionTakenDTO convertActionTakenWithActionRequests(ActionTakenValue actionTaken)

convertActionTaken

public static ActionTakenDTO convertActionTaken(ActionTakenValue actionTaken)

convertActionTaken

protected static ActionTakenDTO convertActionTaken(ActionTakenValue actionTaken,
                                                   boolean fetchActionRequests)

convertResponsibleParty

public static ResponsiblePartyDTO convertResponsibleParty(ResponsibleParty responsibleParty)

convertResponsiblePartyVO

public static ResponsibleParty convertResponsiblePartyVO(ResponsiblePartyDTO responsiblePartyVO)

convertResponsiblePartyVOtoRecipient

public static Recipient convertResponsiblePartyVOtoRecipient(ResponsiblePartyDTO responsiblePartyVO)

refactor name to convertResponsiblePartyVO when ResponsibleParty object is gone

Parameters:

responsiblePartyVO -

Returns:

convertActionRequestDTO

public static ActionRequestValue convertActionRequestDTO(ActionRequestDTO actionRequestDTO)

Converts an ActionRequestVO to an ActionRequest. The ActionRequestDTO passed in must be the root action request in the graph, otherwise an IllegalArgumentException is thrown. This is to avoid potentially sticky issues with circular references in the conversion. NOTE: This method's primary purpose is to convert ActionRequestVOs returned from a RouteModule. Incidentally, the DTO's returned from the route module will be lacking some information (like the node instance) so no attempts are made to convert this data since further initialization is handled by a higher level component (namely ActionRequestService.initializeActionRequestGraph).

convertActionRequestDTO

public static ActionRequestValue convertActionRequestDTO(ActionRequestDTO actionRequestDTO,
                                                         DTOConverter.RouteNodeInstanceLoader routeNodeInstanceLoader)

Converts an ActionRequestVO to an ActionRequest. The ActionRequestDTO passed in must be the root action request in the graph, otherwise an IllegalArgumentException is thrown. This is to avoid potentially sticky issues with circular references in the conversion.

Parameters:

routeNodeInstanceLoader - a service that will provide routeNodeInstanceS based on their IDs.

convertActionRequestVO

protected static ActionRequestValue convertActionRequestVO(ActionRequestDTO actionRequestDTO,
                                                           ActionRequestValue parentActionRequest,
                                                           DTOConverter.RouteNodeInstanceLoader routeNodeInstanceLoader)

convertActionTakenVO

public static ActionTakenValue convertActionTakenVO(ActionTakenDTO actionTakenVO)

convertDocumentRouteStatusChange

public static DocumentRouteStatusChangeDTO convertDocumentRouteStatusChange(DocumentRouteStatusChange statusChange)

convertDocumentRouteLevelChange

public static DocumentRouteLevelChangeDTO convertDocumentRouteLevelChange(DocumentRouteLevelChange routeLevelChange)

convertDeleteEvent

public static DeleteEventDTO convertDeleteEvent(DeleteEvent deleteEvent)

convertActionTakenEvent

public static ActionTakenEventDTO convertActionTakenEvent(ActionTakenEvent actionTakenEvent)

convertBeforeProcessEvent

public static BeforeProcessEventDTO convertBeforeProcessEvent(BeforeProcessEvent event)

convertAfterProcessEvent

public static AfterProcessEventDTO convertAfterProcessEvent(AfterProcessEvent event)

convertDocumentLockingEvent

public static DocumentLockingEventDTO convertDocumentLockingEvent(DocumentLockingEvent event)

convertWorkflowAttributeDefinitionVO

public static AttributeDefinition convertWorkflowAttributeDefinitionVO(WorkflowAttributeDefinitionDTO definitionVO,
                                                                       DocumentType documentType)

convertDocumentDetail

public static DocumentDetailDTO convertDocumentDetail(DocumentRouteHeaderValue routeHeader)
                                               throws WorkflowException

Throws:

WorkflowException

convertRouteNodeInstance

public static RouteNodeInstanceDTO convertRouteNodeInstance(RouteNodeInstance nodeInstance)
                                                     throws WorkflowException

Throws:

WorkflowException

convertStates

public static StateDTO[] convertStates(Collection states)

convertState

public static StateDTO convertState(State nodeState)

convertRouteNode

public static RouteNodeDTO convertRouteNode(RouteNode node)

convertProcess

public static ProcessDTO convertProcess(Process process)

convertMovePointVO

public static MovePoint convertMovePointVO(MovePointDTO movePointVO)

convertAdHocRevokeVO

public static AdHocRevoke convertAdHocRevokeVO(AdHocRevokeDTO revokeVO)
                                        throws WorkflowException

Throws:

WorkflowException

convertWorkflowAttributeValidationError

public static WorkflowAttributeValidationErrorDTO convertWorkflowAttributeValidationError(WorkflowAttributeValidationError error)

updateNotes

public static void updateNotes(RouteHeaderDTO routeHeaderVO,
                               Long routeHeaderId)

convertReportCriteriaDTO

public static SimulationCriteria convertReportCriteriaDTO(ReportCriteriaDTO criteriaVO)

convertReportActionToTakeVO

public static SimulationActionToTake convertReportActionToTakeVO(ReportActionToTakeDTO actionToTakeVO)

convertRuleDelegation

public static RuleDelegationDTO convertRuleDelegation(RuleDelegation ruleDelegation)
                                               throws WorkflowException

Throws:

WorkflowException

convertRuleExtension

public static Collection<RuleExtensionDTO> convertRuleExtension(RuleExtension ruleExtension)
                                                         throws WorkflowException

Throws:

WorkflowException

convertRuleExtensionVO

public static KeyValue convertRuleExtensionVO(RuleExtensionDTO ruleExtensionVO)
                                       throws WorkflowException

Throws:

WorkflowException

convertRuleResponsibility

public static RuleResponsibilityDTO convertRuleResponsibility(RuleResponsibility ruleResponsibility)
                                                       throws WorkflowException

Throws:

WorkflowException

convertRule

public static RuleDTO convertRule(RuleBaseValues ruleValues)
                           throws WorkflowException

Throws:

WorkflowException

convertDocumentSearchCriteriaDTO

public static DocSearchCriteriaDTO convertDocumentSearchCriteriaDTO(DocumentSearchCriteriaDTO criteriaVO)
                                                             throws WorkflowException

Throws:

WorkflowException

convertDocumentSearchResultComponents

public static DocumentSearchResultDTO convertDocumentSearchResultComponents(DocumentSearchResultComponents searchResult)
                                                                     throws WorkflowException

Throws:

WorkflowException

convertDocumentSearchResult

public static DocumentSearchResultRowDTO convertDocumentSearchResult(DocumentSearchResult resultRow)
                                                              throws WorkflowException

Throws:

WorkflowException

convertDocumentStatusTransition

public static DocumentStatusTransitionDTO convertDocumentStatusTransition(DocumentStatusTransition transition)
                                                                   throws WorkflowException

Throws:

WorkflowException

convertDocumentLink

public static DocumentLinkDTO[] convertDocumentLink(Collection<DocumentLink> links)

convertDocumentLinkToArrayList

public static List<DocumentLinkDTO> convertDocumentLinkToArrayList(Collection<DocumentLink> links)

convertDocumentLink

public static DocumentLinkDTO convertDocumentLink(DocumentLink link)