| java.lang.Object
 org.kuali.core.workflow.WorkflowUtils
org.kuali.workflow.KualiWorkflowUtils
| KualiWorkflowUtils | | public class KualiWorkflowUtils extends WorkflowUtils (Code) | | This class contains static utility methods used by the Kuali Workflow Attribute Classes.
|
| Inner Class :public class RouteLevels | |
| Inner Class :public class RouteLevelNames | |
| Method Summary | |
| public static edu.iu.uis.eden.lookupable.Row | buildTextRow(Class propertyClass, String boPropertyName, String workflowPropertyKey)
This method builds a workflow-lookup-screen Row of type TEXT, with no quickfinder/lookup.
Parameters:
propertyClass - The Class of the BO that this row is based on. | | public static edu.iu.uis.eden.lookupable.Row | buildTextRowWithLookup(Class propertyClass, String boPropertyName, String workflowPropertyKey)
This method builds a workflow-lookup-screen Row of type TEXT, with the attached lookup icon and functionality.
Parameters:
propertyClass - The Class of the BO that this row is based on. | | public static edu.iu.uis.eden.lookupable.Row | buildTextRowWithLookup(Class propertyClass, String boPropertyName, String workflowPropertyKey, Map fieldConversionsByBoPropertyName)
This method builds a workflow-lookup-screen Row of type TEXT, with the attached lookup icon and functionality.
Parameters:
propertyClass - The Class of the BO that this row is based on. | | final public static String | getBusinessObjectAttributeLabel(Class businessObjectClass, String attributeName)
| | final public static Document | getDocument(String xmlDocumentContent)
TODO: remove this method when we upgrade to workflow 2.2 - the problem that this helps with is as follows:
StandardWorkflowEngine is not currently setting up the DocumentContent on the RouteContext object. | | public static KualiDecimal | getFinancialDocumentTotalAmount(RouteContext routeContext)
This method gets the document total amount from the DocumentHeader If an XPathExpressionException is thrown, this will be
re-thrown within a RuntimeException. | | public static KualiDecimal | getFinancialDocumentTotalAmount(Document document)
This method gets the document total amount from the DocumentHeader
If an XPathExpressionException is thrown, this will be re-thrown within a RuntimeException. | | final public static String | getSourceAccountingLineClassName(String documentTypeName)
This method uses the document type name to get the AccountingDocument implementation class from the data dictionary, creates
a new instance and uses the getSourceAccountingLine method to get the name of the source accounting line class. | | final public static String | getTargetAccountingLineClassName(String documentTypeName)
This method uses the document type name to get the AccountingDocument implementation class from the data dictionary, creates
a new instance and uses the getTargetAccountingLine method to get the name of the target accounting line class. | | final public static boolean | isMaintenanceDocument(DocumentType documentType)
| | public static boolean | isSourceLineOnly(String documentTypeName)
| | public static boolean | isTargetLineOnly(String documentTypeName)
| | public static List | setKualiFieldValues(List workflowRows, String businessObjectClassName)
This is for use by xml WorkflowAttribute implementations. | | final public static String | xstreamSafeEval(XPath xpath, String xpathExpression, Object item)
This method will do a simple XPath.evaluate, while wrapping your xpathExpression with the xstreamSafe function. | | final public static String | xstreamSafeXPath(String xpathExpression)
This method wraps the passed-in XPath expression in XStream Safe wrappers, so that XStream generated reference links will be
handled correctly.
Parameters:
xpathExpression - The XPath Expression you wish to use. |
| ACCOUNTS_PAYABLE_CREDIT_MEMO_DOCUMENT_TYPE | | final public static String ACCOUNTS_PAYABLE_CREDIT_MEMO_DOCUMENT_TYPE(Code) | | |
| ACCOUNTS_PAYABLE_PAYMENT_REQUEST_DOCUMENT_TYPE | | final public static String ACCOUNTS_PAYABLE_PAYMENT_REQUEST_DOCUMENT_TYPE(Code) | | |
| ACCOUNT_CHANGE_DOC_TYPE | | final public static String ACCOUNT_CHANGE_DOC_TYPE(Code) | | |
| ACCOUNT_DELEGATE_GLOBAL_DOC_TYPE | | final public static String ACCOUNT_DELEGATE_GLOBAL_DOC_TYPE(Code) | | |
| ACCOUNT_DEL_DOC_TYPE | | final public static String ACCOUNT_DEL_DOC_TYPE(Code) | | |
| ACCOUNT_DOC_TYPE | | final public static String ACCOUNT_DOC_TYPE(Code) | | |
| ACCOUNT_GLOBAL_DETAILS_XPATH | | final public static String ACCOUNT_GLOBAL_DETAILS_XPATH(Code) | | |
| BUDGET_ADJUSTMENT_DOC_TYPE | | final public static String BUDGET_ADJUSTMENT_DOC_TYPE(Code) | | |
| CHART_ORG_WORKGROUP_DOC_TYPE | | final public static String CHART_ORG_WORKGROUP_DOC_TYPE(Code) | | |
| C_G_AWARD_DOC_TYPE | | final public static String C_G_AWARD_DOC_TYPE(Code) | | |
| C_G_PROPOSAL_DOC_TYPE | | final public static String C_G_PROPOSAL_DOC_TYPE(Code) | | |
| DISBURSEMENT_VOCHER_DOC_TYPE | | final public static String DISBURSEMENT_VOCHER_DOC_TYPE(Code) | | |
| FINANCIAL_DOCUMENT_TOTAL_AMOUNT_XPATH | | final public static String FINANCIAL_DOCUMENT_TOTAL_AMOUNT_XPATH(Code) | | |
| FINANCIAL_DOC_TYPE | | final public static String FINANCIAL_DOC_TYPE(Code) | | |
| FINANCIAL_YEAR_END_DOC_TYPE | | final public static String FINANCIAL_YEAR_END_DOC_TYPE(Code) | | |
| FIS_USER_DOC_TYPE | | final public static String FIS_USER_DOC_TYPE(Code) | | |
| GENERAL_ERROR_CORRECTION_DOC_TYPE | | final public static String GENERAL_ERROR_CORRECTION_DOC_TYPE(Code) | | |
| GENERAL_LEDGER_ERROR_CORRECTION_DOC_TYPE | | final public static String GENERAL_LEDGER_ERROR_CORRECTION_DOC_TYPE(Code) | | |
| INTERNAL_BILLING_DOC_TYPE | | final public static String INTERNAL_BILLING_DOC_TYPE(Code) | | |
| KRA_BUDGET_DOC_TYPE | | final public static String KRA_BUDGET_DOC_TYPE(Code) | | |
| KRA_ROUTING_FORM_DOC_TYPE | | final public static String KRA_ROUTING_FORM_DOC_TYPE(Code) | | |
| MAINTENANCE_DOC_TYPE | | final public static String MAINTENANCE_DOC_TYPE(Code) | | |
| NEW_MAINTAINABLE_PREFIX | | final public static String NEW_MAINTAINABLE_PREFIX(Code) | | |
| NEW_MAINTAINABLE_PREFIX_NTS | | final public static String NEW_MAINTAINABLE_PREFIX_NTS(Code) | | |
| NON_CHECK_DISBURSEMENT_DOC_TYPE | | final public static String NON_CHECK_DISBURSEMENT_DOC_TYPE(Code) | | |
| OBJECT_CODE_CHANGE_DOC_TYPE | | final public static String OBJECT_CODE_CHANGE_DOC_TYPE(Code) | | |
| OLD_MAINTAINABLE_PREFIX | | final public static String OLD_MAINTAINABLE_PREFIX(Code) | | |
| OLD_MAINTAINABLE_PREFIX_NTS | | final public static String OLD_MAINTAINABLE_PREFIX_NTS(Code) | | |
| ORGANIZATION_DOC_TYPE | | final public static String ORGANIZATION_DOC_TYPE(Code) | | |
| ORG_REVERSION_CHANGE_DOC_TYPE | | final public static String ORG_REVERSION_CHANGE_DOC_TYPE(Code) | | |
| ORG_REVERSION_GLOBALS_XPATH | | final public static String ORG_REVERSION_GLOBALS_XPATH(Code) | | |
| PRE_ENCUMBRANCE_DOC_TYPE | | final public static String PRE_ENCUMBRANCE_DOC_TYPE(Code) | | |
| PROCUREMENT_CARD_DOC_TYPE | | final public static String PROCUREMENT_CARD_DOC_TYPE(Code) | | |
| PROJECT_CODE_DOC_TYPE | | final public static String PROJECT_CODE_DOC_TYPE(Code) | | |
| SIMPLE_MAINTENANCE_DOC_TYPE | | final public static String SIMPLE_MAINTENANCE_DOC_TYPE(Code) | | |
| SOURCE_LINE_ONLY_DOCUMENT_TYPES | | final public static Set SOURCE_LINE_ONLY_DOCUMENT_TYPES(Code) | | |
| SUB_ACCOUNT_DOC_TYPE | | final public static String SUB_ACCOUNT_DOC_TYPE(Code) | | |
| SUB_OBJECT_CODE_CHANGE_DOC_TYPE | | final public static String SUB_OBJECT_CODE_CHANGE_DOC_TYPE(Code) | | |
| SUB_OBJECT_DOC_TYPE | | final public static String SUB_OBJECT_DOC_TYPE(Code) | | |
| TARGET_LINE_ONLY_DOCUMENT_TYPES | | final public static Set TARGET_LINE_ONLY_DOCUMENT_TYPES(Code) | | |
| XML_REPORT_DOC_CONTENT_PREFIX | | final public static String XML_REPORT_DOC_CONTENT_PREFIX(Code) | | |
| XML_REPORT_DOC_CONTENT_SUFFIX | | final public static String XML_REPORT_DOC_CONTENT_SUFFIX(Code) | | |
| XML_REPORT_DOC_CONTENT_XPATH_PREFIX | | final public static String XML_REPORT_DOC_CONTENT_XPATH_PREFIX(Code) | | |
| XPATH_ELEMENT_SEPARATOR | | final public static String XPATH_ELEMENT_SEPARATOR(Code) | | |
| buildTextRow | | public static edu.iu.uis.eden.lookupable.Row buildTextRow(Class propertyClass, String boPropertyName, String workflowPropertyKey)(Code) | | This method builds a workflow-lookup-screen Row of type TEXT, with no quickfinder/lookup.
Parameters:
propertyClass - The Class of the BO that this row is based on. For example, Account.class for accountNumber.
Parameters:
boPropertyName - The property name on the BO that this row is based on. For example, accountNumber forAccount.accountNumber.
Parameters:
workflowPropertyKey - The workflow-lookup-screen property key. For example, account_nbr for Account.accountNumber. Thiskey can be anything, but needs to be consistent with what is used for the row/field key on the java attribute, soeverything links up correctly. A populated and ready-to-use workflow lookupable.Row. |
| buildTextRowWithLookup | | public static edu.iu.uis.eden.lookupable.Row buildTextRowWithLookup(Class propertyClass, String boPropertyName, String workflowPropertyKey)(Code) | | This method builds a workflow-lookup-screen Row of type TEXT, with the attached lookup icon and functionality.
Parameters:
propertyClass - The Class of the BO that this row is based on. For example, Account.class for accountNumber.
Parameters:
boPropertyName - The property name on the BO that this row is based on. For example, accountNumber forAccount.accountNumber.
Parameters:
workflowPropertyKey - The workflow-lookup-screen property key. For example, account_nbr for Account.accountNumber. Thiskey can be anything, but needs to be consistent with what is used for the row/field key on the java attribute, soeverything links up correctly. A populated and ready-to-use workflow lookupable.Row, which includes both the property field and the lookup icon. |
| buildTextRowWithLookup | | public static edu.iu.uis.eden.lookupable.Row buildTextRowWithLookup(Class propertyClass, String boPropertyName, String workflowPropertyKey, Map fieldConversionsByBoPropertyName)(Code) | | This method builds a workflow-lookup-screen Row of type TEXT, with the attached lookup icon and functionality.
Parameters:
propertyClass - The Class of the BO that this row is based on. For example, Account.class for accountNumber.
Parameters:
boPropertyName - The property name on the BO that this row is based on. For example, accountNumber forAccount.accountNumber.
Parameters:
workflowPropertyKey - The workflow-lookup-screen property key. For example, account_nbr for Account.accountNumber. Thiskey can be anything, but needs to be consistent with what is used for the row/field key on the java attribute, soeverything links up correctly.
Parameters:
fieldConversionsByBoPropertyName - A list of extra field conversions where the key is the business object property nameand the value is the workflow property key A populated and ready-to-use workflow lookupable.Row, which includes both the property field and the lookup icon. |
| getBusinessObjectAttributeLabel | | final public static String getBusinessObjectAttributeLabel(Class businessObjectClass, String attributeName)(Code) | | This method returns a label from the data dictionary service
Parameters:
businessObjectClass - - class where the label should come from
Parameters:
attributeName - - name of the attribute you need the label for the label from the data dictionary for the given Class and attributeName or null if not found |
| getDocument | | final public static Document getDocument(String xmlDocumentContent)(Code) | | TODO: remove this method when we upgrade to workflow 2.2 - the problem that this helps with is as follows:
StandardWorkflowEngine is not currently setting up the DocumentContent on the RouteContext object. Instead that's being
handled by the RequestsNode which, in the case of the BudgetAdjustmentDocument, we never pass through before hitting the
first split. So, in that particular case, we have to reference an attribute that gives us the xml string and translate that
to a dom document ourselves.
Parameters:
xmlDocumentContent - a dom representation of the xml provided |
| getFinancialDocumentTotalAmount | | public static KualiDecimal getFinancialDocumentTotalAmount(RouteContext routeContext)(Code) | | This method gets the document total amount from the DocumentHeader If an XPathExpressionException is thrown, this will be
re-thrown within a RuntimeException.
Parameters:
routeContext - The RouteContext object from the workflow system the KualiDecimal value of the total amount from the document's workflow document content or null if the amount valuecannot be found. |
| getFinancialDocumentTotalAmount | | public static KualiDecimal getFinancialDocumentTotalAmount(Document document)(Code) | | This method gets the document total amount from the DocumentHeader
If an XPathExpressionException is thrown, this will be re-thrown within a RuntimeException.
Parameters:
document - - the document object from the workflow system the KualiDecimal value of the total amount from the document's workflow document content or null if the amount valuecannot be found. |
| getSourceAccountingLineClassName | | final public static String getSourceAccountingLineClassName(String documentTypeName)(Code) | | This method uses the document type name to get the AccountingDocument implementation class from the data dictionary, creates
a new instance and uses the getSourceAccountingLine method to get the name of the source accounting line class. It is
intended for use by our workflow attributes when building xpath expressions
Parameters:
documentTypeName - the document type name to use when querying the TransactionalDocumentDataDictionaryService the name of the source accounting line class associated with the specified workflow document type name |
| getTargetAccountingLineClassName | | final public static String getTargetAccountingLineClassName(String documentTypeName)(Code) | | This method uses the document type name to get the AccountingDocument implementation class from the data dictionary, creates
a new instance and uses the getTargetAccountingLine method to get the name of the target accounting line class. It is
intended for use by our workflow attributes when building xpath expressions
Parameters:
documentTypeName - the document type name to use when querying the TransactionalDocumentDataDictionaryService the name of the target accounting line class associated with the specified workflow document type name |
| isMaintenanceDocument | | final public static boolean isMaintenanceDocument(DocumentType documentType)(Code) | | |
| isSourceLineOnly | | public static boolean isSourceLineOnly(String documentTypeName)(Code) | | |
| isTargetLineOnly | | public static boolean isTargetLineOnly(String documentTypeName)(Code) | | |
| setKualiFieldValues | | public static List setKualiFieldValues(List workflowRows, String businessObjectClassName)(Code) | | This is for use by xml WorkflowAttribute implementations. It overrides the label and help url of the test fields on the
edu.iu.uis.eden.lookupable.Rows obtained from the workflow parent class with the appropriate values from the data dictionary.
Parameters:
workflowRows - A list of edu.iu.uis.eden.lookupable.Row objects provided by the workflow superclass, based on the XMLattribute definition.
Parameters:
businessObjectClass - The BusinessObject Class extracted from the meta data specified in the XML attribute definition,which is used in querying the data dictionary for the field definition. |
| xstreamSafeEval | | final public static String xstreamSafeEval(XPath xpath, String xpathExpression, Object item)(Code) | | This method will do a simple XPath.evaluate, while wrapping your xpathExpression with the xstreamSafe function. It assumes a
String result, and will return such. If an XPathExpressionException is thrown, this will be re-thrown within a
RuntimeException.
Parameters:
xpath - A correctly initialized XPath instance.
Parameters:
xpathExpression - Your XPath Expression that needs to be wrapped in an xstreamSafe wrapper and run.
Parameters:
item - The document contents you will be searching within. The string value of the xpath.evaluate(). |
| xstreamSafeXPath | | final public static String xstreamSafeXPath(String xpathExpression)(Code) | | This method wraps the passed-in XPath expression in XStream Safe wrappers, so that XStream generated reference links will be
handled correctly.
Parameters:
xpathExpression - The XPath Expression you wish to use. Your XPath Expression wrapped in the XStreamSafe wrapper. |
|
|