Coverage Report

Coverage Report - org.kuali.student.lum.workflow.qualifierresolver.CocOrganizationQualifierResolver

Classes in this File

0/20

0/8

 /**
  * 
  */
 package org.kuali.student.lum.workflow.qualifierresolver;
 
 import java.util.ArrayList;
 import java.util.List;
 
 import org.apache.commons.lang.StringUtils;
 import org.kuali.rice.kew.engine.RouteContext;
 import org.kuali.rice.kew.engine.node.RouteNodeUtils;
 import org.kuali.rice.kim.bo.types.dto.AttributeSet;
 import org.kuali.student.common.search.dto.SearchResultRow;
 
 /**
  * A QualifierResolver class that will use configuration elements from the Route Node xml configuration to get a list of
  * organizations related to the organization(s) that are set in the document content xml for a particular document
  * instance.
  * 
  * <p>
  * A sample of the Route Node configuration:
  * <p>
  * 
  * <pre>
  * {@code
  * <role name="Document Organization Review">
  *   <activationType>P</activationType>
  *   <qualifierResolverClass>org.kuali.student.lum.workflow.qualifierresolver.CocOrganizationQualifierResolver</qualifierResolverClass>
  *   <useNonDerivedRoles>true</useNonDerivedRoles>
  *   <organizationIdQualifierKey>orgId</organizationIdQualifierKey>
  *   <organizationIdDocumentContentKey>orgId</organizationIdDocumentContentKey>
  * </role>
  * }
  * </pre>
  * 
  * <p>
  * A sample of the Document Content xml expected by default:
  * <p>
  * 
  * <pre>
  * {@code
  * <info>
  *   <orgId>1234</orgId>
  *   <orgId>5678</orgId>
  * </info>
  * }
  * </pre>
  * 
  */
 public class CocOrganizationQualifierResolver extends AbstractOrganizationServiceQualifierResolver {
 
     protected static final String ROUTE_NODE_XML_ORG_ID_QUALIFIER_KEY = "organizationIdQualifierKey";
     protected static final String ROUTE_NODE_XML_USE_NON_DERIVED_ROLES = "useNonDerivedRoles";
 
     public static final String KUALI_ORG_TYPE_CURRICULUM_PARENT = "kuali.org.CurriculumParent";
     public static final String KUALI_ORG_HIERARCHY_CURRICULUM = "kuali.org.hierarchy.Curriculum";
     public static final String KUALI_ORG_COC = "kuali.org.COC";
 
     /**
      * @see org.kuali.rice.kew.role.QualifierResolver#resolve(org.kuali.rice.kew.engine.RouteContext)
      */
     @Override
     public List<AttributeSet> resolve(RouteContext context) {
         List<AttributeSet> attributeSets = new ArrayList<AttributeSet>();
         String orgIdKey = getNodeSpecificOrganizationIdAttributeSetKey(context);
         for (String orgId : getOrganizationIdsFromDocumentContent(context)) {
             List<SearchResultRow> results = relatedOrgsFromOrgId(orgId, getOrganizationRelationTypeCode(), getRelatedOrganizationTypeCode());
             attributeSets.addAll(attributeSetFromSearchResult(results, orgIdKey));
         }
         return attributeSets;
     }
 
     public String getNodeSpecificOrganizationIdAttributeSetKey(RouteContext context) {
         String organizationIdFieldKey = RouteNodeUtils.getValueOfCustomProperty(context.getNodeInstance().getRouteNode(), ROUTE_NODE_XML_ORG_ID_QUALIFIER_KEY);
         if (StringUtils.isBlank(organizationIdFieldKey)) {
             if (usesNonDerivedOrganizationRoles(context)) {
                 throw new RuntimeException("Cannot find required XML element '" + ROUTE_NODE_XML_ORG_ID_QUALIFIER_KEY + "' on the Route Node XML configuration.");
             }
         }
         return organizationIdFieldKey;
     }
     
     public Boolean usesNonDerivedOrganizationRoles(RouteContext context) {
         String useNonDerivedOrganizationRoles = RouteNodeUtils.getValueOfCustomProperty(context.getNodeInstance().getRouteNode(), ROUTE_NODE_XML_USE_NON_DERIVED_ROLES);
         if (StringUtils.isNotBlank(useNonDerivedOrganizationRoles)) {
             return Boolean.valueOf(useNonDerivedOrganizationRoles);
         }
         return true;
     }
 
     protected String getOrganizationHierarchyTypeCode() {
         return KUALI_ORG_HIERARCHY_CURRICULUM;
     }
 
     protected String getOrganizationRelationTypeCode() {
         return KUALI_ORG_TYPE_CURRICULUM_PARENT;
     }
 
     protected String getRelatedOrganizationTypeCode() {
         return KUALI_ORG_COC;
     }
 
 }

1		/**
2		*
3		*/
4		package org.kuali.student.lum.workflow.qualifierresolver;
5
6		import java.util.ArrayList;
7		import java.util.List;
8
9		import org.apache.commons.lang.StringUtils;
10		import org.kuali.rice.kew.engine.RouteContext;
11		import org.kuali.rice.kew.engine.node.RouteNodeUtils;
12		import org.kuali.rice.kim.bo.types.dto.AttributeSet;
13		import org.kuali.student.common.search.dto.SearchResultRow;
14
15		/**
16		* A QualifierResolver class that will use configuration elements from the Route Node xml configuration to get a list of
17		* organizations related to the organization(s) that are set in the document content xml for a particular document
18		* instance.
19		*
20		* <p>
21		* A sample of the Route Node configuration:
22		* <p>
23		*
24		* <pre>
25		* {@code
26		* <role name="Document Organization Review">
27		* <activationType>P</activationType>
28		* <qualifierResolverClass>org.kuali.student.lum.workflow.qualifierresolver.CocOrganizationQualifierResolver</qualifierResolverClass>
29		* <useNonDerivedRoles>true</useNonDerivedRoles>
30		* <organizationIdQualifierKey>orgId</organizationIdQualifierKey>
31		* <organizationIdDocumentContentKey>orgId</organizationIdDocumentContentKey>
32		* </role>
33		* }
34		* </pre>
35		*
36		* <p>
37		* A sample of the Document Content xml expected by default:
38		* <p>
39		*
40		* <pre>
41		* {@code
42		* <info>
43		* <orgId>1234</orgId>
44		* <orgId>5678</orgId>
45		* </info>
46		* }
47		* </pre>
48		*
49		*/
50	0	public class CocOrganizationQualifierResolver extends AbstractOrganizationServiceQualifierResolver {
51
52		protected static final String ROUTE_NODE_XML_ORG_ID_QUALIFIER_KEY = "organizationIdQualifierKey";
53		protected static final String ROUTE_NODE_XML_USE_NON_DERIVED_ROLES = "useNonDerivedRoles";
54
55		public static final String KUALI_ORG_TYPE_CURRICULUM_PARENT = "kuali.org.CurriculumParent";
56		public static final String KUALI_ORG_HIERARCHY_CURRICULUM = "kuali.org.hierarchy.Curriculum";
57		public static final String KUALI_ORG_COC = "kuali.org.COC";
58
59		/**
60		* @see org.kuali.rice.kew.role.QualifierResolver#resolve(org.kuali.rice.kew.engine.RouteContext)
61		*/
62		@Override
63		public List<AttributeSet> resolve(RouteContext context) {
64	0	List<AttributeSet> attributeSets = new ArrayList<AttributeSet>();
65	0	String orgIdKey = getNodeSpecificOrganizationIdAttributeSetKey(context);
66	0	for (String orgId : getOrganizationIdsFromDocumentContent(context)) {
67	0	List<SearchResultRow> results = relatedOrgsFromOrgId(orgId, getOrganizationRelationTypeCode(), getRelatedOrganizationTypeCode());
68	0	attributeSets.addAll(attributeSetFromSearchResult(results, orgIdKey));
69	0	}
70	0	return attributeSets;
71		}
72
73		public String getNodeSpecificOrganizationIdAttributeSetKey(RouteContext context) {
74	0	String organizationIdFieldKey = RouteNodeUtils.getValueOfCustomProperty(context.getNodeInstance().getRouteNode(), ROUTE_NODE_XML_ORG_ID_QUALIFIER_KEY);
75	0	if (StringUtils.isBlank(organizationIdFieldKey)) {
76	0	if (usesNonDerivedOrganizationRoles(context)) {
77	0	throw new RuntimeException("Cannot find required XML element '" + ROUTE_NODE_XML_ORG_ID_QUALIFIER_KEY + "' on the Route Node XML configuration.");
78		}
79		}
80	0	return organizationIdFieldKey;
81		}
82
83		public Boolean usesNonDerivedOrganizationRoles(RouteContext context) {
84	0	String useNonDerivedOrganizationRoles = RouteNodeUtils.getValueOfCustomProperty(context.getNodeInstance().getRouteNode(), ROUTE_NODE_XML_USE_NON_DERIVED_ROLES);
85	0	if (StringUtils.isNotBlank(useNonDerivedOrganizationRoles)) {
86	0	return Boolean.valueOf(useNonDerivedOrganizationRoles);
87		}
88	0	return true;
89		}
90
91		protected String getOrganizationHierarchyTypeCode() {
92	0	return KUALI_ORG_HIERARCHY_CURRICULUM;
93		}
94
95		protected String getOrganizationRelationTypeCode() {
96	0	return KUALI_ORG_TYPE_CURRICULUM_PARENT;
97		}
98
99		protected String getRelatedOrganizationTypeCode() {
100	0	return KUALI_ORG_COC;
101		}
102
103		}