edu.sampleu.travel.workflow
Class EmployeeAttribute

java.lang.Object
  extended by org.kuali.rice.kew.rule.AbstractWorkflowAttribute
      extended by org.kuali.rice.kew.rule.GenericWorkflowAttribute
          extended by org.kuali.rice.kew.rule.GenericRoleAttribute
              extended by edu.sampleu.travel.workflow.EmployeeAttribute
All Implemented Interfaces:
Serializable, RoleAttribute, WorkflowAttribute

public class EmployeeAttribute
extends GenericRoleAttribute

An attribute implementation that can resolve organizational roles

See Also:
Serialized Form

Field Summary
private static Role DIRECTOR_ROLE
           
private static Role EMPLOYEE_ROLE
           
private static List<Role> ROLES
           
private static Role SUPERVISOR_ROLE
           
private  String traveler
          Traveler to be set by client application so that doc content can be generated appropriately
private static String USERID_FORM_FIELDNAME
           
 
Fields inherited from class org.kuali.rice.kew.rule.GenericWorkflowAttribute
attributeName, content, log
 
Fields inherited from class org.kuali.rice.kew.rule.AbstractWorkflowAttribute
required
 
Constructor Summary
EmployeeAttribute()
           
EmployeeAttribute(String traveler)
           
 
Method Summary
 List getFieldConversions()
          Required to support flex routing report
 Map<String,String> getProperties()
          Template method for subclasses to override to expose attribute state
protected  List<String> getRoleNameQualifiers(String roleName, DocumentContent documentContent)
          Template method responsible for producing qualifiers for a role name
 List<Role> getRoleNames()
          List of Roles this RoleAttribute supports
 List<Row> getRoutingDataRows()
          RoutingDataRows contain Rows describing the UI-level presentation of the ruleData fields used to determine where a given document would be routed according to the associated rule.
protected  boolean isValidRole(String roleName)
           
protected  ResolvedQualifiedRole resolveQualifiedRole(RouteContext routeContext, QualifiedRoleName qualifiedRoleName)
          Template method that delegates to GenericRoleAttribute.resolveRecipients(RouteContext, QualifiedRoleName) and {@link #getLabelForQualifiedRoleName(QualifiedRoleName)
protected  List<Id> resolveRecipients(RouteContext routeContext, QualifiedRoleName qualifiedRoleName)
          Template method for subclasses to implement
 void setTraveler(String traveler)
          for edoclite??
 List validateRoutingData(Map paramMap)
          These guys should probably be implemented to set the parameters on an internal member property map this attribute should use to contain all properties set on it, like StandardGenericXmlAttribute.
 
Methods inherited from class org.kuali.rice.kew.rule.GenericRoleAttribute
generateQualifiedRoleNames, getLabelForQualifiedRoleName, getQualifiedRoleNames, isMatch, resolveQualifiedRole
 
Methods inherited from class org.kuali.rice.kew.rule.GenericWorkflowAttribute
getDocContent, getRuleExtensionValues, isMatch, isMatch, validateRuleData
 
Methods inherited from class org.kuali.rice.kew.rule.AbstractWorkflowAttribute
getIdFieldName, getLockFieldName, getRuleRows, isRequired, setRequired
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPLOYEE_ROLE

private static final Role EMPLOYEE_ROLE

SUPERVISOR_ROLE

private static final Role SUPERVISOR_ROLE

DIRECTOR_ROLE

private static final Role DIRECTOR_ROLE

ROLES

private static final List<Role> ROLES

USERID_FORM_FIELDNAME

private static String USERID_FORM_FIELDNAME

traveler

private String traveler
Traveler to be set by client application so that doc content can be generated appropriately

Constructor Detail

EmployeeAttribute

public EmployeeAttribute()

EmployeeAttribute

public EmployeeAttribute(String traveler)
Method Detail

setTraveler

public void setTraveler(String traveler)
for edoclite??


getRoleNames

public List<Role> getRoleNames()
Description copied from interface: RoleAttribute
List of Roles this RoleAttribute supports

Returns:
list of Roles this RoleAttribute supports

isValidRole

protected boolean isValidRole(String roleName)

getRoleNameQualifiers

protected List<String> getRoleNameQualifiers(String roleName,
                                             DocumentContent documentContent)
Description copied from class: GenericRoleAttribute
Template method responsible for producing qualifiers for a role name

Overrides:
getRoleNameQualifiers in class GenericRoleAttribute

resolveQualifiedRole

protected ResolvedQualifiedRole resolveQualifiedRole(RouteContext routeContext,
                                                     QualifiedRoleName qualifiedRoleName)
Description copied from class: GenericRoleAttribute
Template method that delegates to GenericRoleAttribute.resolveRecipients(RouteContext, QualifiedRoleName) and {@link #getLabelForQualifiedRoleName(QualifiedRoleName)

Overrides:
resolveQualifiedRole in class GenericRoleAttribute

resolveRecipients

protected List<Id> resolveRecipients(RouteContext routeContext,
                                     QualifiedRoleName qualifiedRoleName)
Description copied from class: GenericRoleAttribute
Template method for subclasses to implement

Overrides:
resolveRecipients in class GenericRoleAttribute

getProperties

public Map<String,String> getProperties()
Description copied from class: GenericWorkflowAttribute
Template method for subclasses to override to expose attribute state

Specified by:
getProperties in class GenericWorkflowAttribute
Returns:
map exposing attribute state

getFieldConversions

public List getFieldConversions()
Required to support flex routing report

See Also:
org.kuali.rice.kew.rule.WorkflowAttribute#getFieldConversions()

getRoutingDataRows

public List<Row> getRoutingDataRows()
Description copied from interface: WorkflowAttribute
RoutingDataRows contain Rows describing the UI-level presentation of the ruleData fields used to determine where a given document would be routed according to the associated rule.

The getRoutingDataRows method returns a list of rows that contain Fields describing the UI-level presentation of a single RuleExtensionValue for the routing report feature. These rows are used to determine where an eDoc would route if these values were entered. They are constructed the same way rule rows are described above and a lot of times are identical.

Additionally, it is very important that the List of Row objects is reconstructed every time getRoutingDataRows is called. This is because the code which processes these Rows will set the propertyValue directly on the Field objects contained within. Essentially, this means the Rows and Fields should not be constructed once inside of the attribute and cached statically, but instead be recreated each time this method is called.

Specified by:
getRoutingDataRows in interface WorkflowAttribute
Overrides:
getRoutingDataRows in class AbstractWorkflowAttribute

validateRoutingData

public List validateRoutingData(Map paramMap)
Description copied from class: GenericWorkflowAttribute
These guys should probably be implemented to set the parameters on an internal member property map this attribute should use to contain all properties set on it, like StandardGenericXmlAttribute.

Specified by:
validateRoutingData in interface WorkflowAttribute
Overrides:
validateRoutingData in class GenericWorkflowAttribute
See Also:
TODO: implement me!


Copyright © 2007-2011 The Kuali Foundation. All Rights Reserved.