com.tsgrp.opencontent.wizard.workflow.util

Class WFUtil

java.lang.Object

com.tsgrp.opencontent.wizard.workflow.util.WFUtil

public class WFUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WFUtil()

Method Summary

Modifier and Type	Method and Description
static org.jdom.Document	getActivitiesDocument(java.lang.String ticket, java.lang.String pageSetName) Returns the Activities XML for the given page set name, or null if the page set does not have workflow activities configured.
static org.jdom.Document	getRoleDocument(java.lang.String ticket, java.lang.String pageSetName, java.lang.String roleName) Get the role document for the given role name and page set.
static WFRule[]	parseWFRules(org.jdom.Element wFRulesElement)
static WizardRole	parseWizardRole(org.jdom.Document roleXml) Parses the wizard role XML into a WizardRole object.
static java.lang.String	stringifyOperator(java.lang.String operator) Stringifies a non-proximity date rule operator.
static java.lang.String	stringifyProximityOperator(java.lang.String operator, org.jdom.Element rule) Stringifies a roximity date rule operator.
static java.lang.String	stringifyRule(org.jdom.Element rule) Takes the given rule element and returns it as a human readable string.

Methods inherited from class java.lang.Object

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

Constructor Detail

WFUtil

public WFUtil()

Method Detail

parseWFRules

public static WFRule[] parseWFRules(org.jdom.Element wFRulesElement)

parseWizardRole

public static WizardRole parseWizardRole(org.jdom.Document roleXml)

Parses the wizard role XML into a WizardRole object. TODO - this is only a stopgap method. We need to reconcile this with the old model objects in wizard.core.model

Parameters:

roleXml - the role XML document

Returns:

the WizardRole object

stringifyRule

public static java.lang.String stringifyRule(org.jdom.Element rule)
                                      throws java.lang.Exception

Takes the given rule element and returns it as a human readable string. Template text for the different rule types are:

• String: {input-short-label} is / is not / contains / does not contain / starts with / ends with {option-value}
• Boolean: {input-short-label} is true / false
• Number: {input-short-label} is / is not / is greater than / is less than {option-value}
• Date: {input-short-label} is / is not / is before / is after {option-value}
• Proximity Date: {input-short-label} is {num} days before / after / before or after {option-value}
• Proximity Date (exclude weekends): {input-short-label} is {num} days before / after / before or after {option-value}, excluding weekends

Parameters:

rule - the rule XML

Returns:

the human readable text

Throws:

java.lang.Exception - if an error occurs.

stringifyProximityOperator

public static java.lang.String stringifyProximityOperator(java.lang.String operator,
                                                          org.jdom.Element rule)
                                                   throws java.lang.Exception

Stringifies a roximity date rule operator. Calling methods must use an OPERATOR field in IOpenContentRule.

Parameters:

operator - the operator

rule - the Rule element. This is needed to get the proximity days.

Returns:

the strigified value

Throws:

java.lang.Exception - if an error occurs

See Also:

IOpenContentRule

stringifyOperator

public static java.lang.String stringifyOperator(java.lang.String operator)

Stringifies a non-proximity date rule operator. Calling methods must use an OPERATOR field in IOpenContentRule.

Parameters:

operator - the operator

Returns:

the strigified value

See Also:

IOpenContentRule

getActivitiesDocument

public static org.jdom.Document getActivitiesDocument(java.lang.String ticket,
                                                      java.lang.String pageSetName)
                                               throws java.lang.Exception

Returns the Activities XML for the given page set name, or null if the page set does not have workflow activities configured. This method retrieves the activities object by looking at the related activities on the page set definition, and then grabs the first one (there should only ever be one child relation.

Parameters:

ticket - the oc ticket

pageSetName - the name of the page set

Returns:

the Activities XML, or null if it does not exist

Throws:

java.lang.Exception

getRoleDocument

public static org.jdom.Document getRoleDocument(java.lang.String ticket,
                                                java.lang.String pageSetName,
                                                java.lang.String roleName)
                                         throws java.lang.Exception

Get the role document for the given role name and page set. This method retrieves the role by looking at the related roles on the page set definition, and then iterates and find the role with the given name

Parameters:

ticket - the OC ticket

roleName - the name of the role to retrieve

pageSetName - the name of the page set

Returns:

the Document for the role

Throws:

java.lang.Exception - if an error occurs