View Javadoc

1   /*
2    * Copyright 2005-2007 The Kuali Foundation
3    *
4    *
5    * Licensed under the Educational Community License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    * http://www.opensource.org/licenses/ecl2.php
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.kuali.rice.kew.rule;
18  
19  import java.util.ArrayList;
20  import java.util.Collections;
21  import java.util.List;
22  
23  import org.kuali.rice.kew.engine.RouteContext;
24  import org.kuali.rice.kew.identity.PrincipalId;
25  
26  
27  /**
28   * RoleAttribute that exposes a document's user who routed the document
29   *
30   * @author Kuali Rice Team (rice.collab@kuali.org)
31   */
32  public class RoutedByUserRoleAttribute extends UnqualifiedRoleAttribute {
33      private static final long serialVersionUID = -7099014184598851664L;
34  	private static final String ROUTED_BY_USER_ROLE_KEY = "ROUTED_BY_USER";
35      private static final String ROUTED_BY_USER_ROLE_LABEL = "Routed By User";
36  
37      private static final Role ROLE = new Role(RoutedByUserRoleAttribute.class, ROUTED_BY_USER_ROLE_KEY, ROUTED_BY_USER_ROLE_LABEL);
38      private static final List<Role> ROLES;
39      static {
40          ArrayList<Role> roles = new ArrayList<Role>(1);
41          roles.add(ROLE);
42          ROLES = Collections.unmodifiableList(roles);
43      }
44  
45      public RoutedByUserRoleAttribute() {
46          super(ROLES);
47      }
48  
49      public ResolvedQualifiedRole resolveRole(RouteContext routeContext, String roleName) {
50          // sounds like the role label should be specified as the first parameter here,
51          // but I'll follow AccountAttribute's lead and specify the role key
52          List members = new ArrayList(1);
53          //members.add(routeContext.getDocument().getRoutedByPrincipal().getPrincipalId());
54          members.add(new PrincipalId(routeContext.getDocument().getRoutedByUserWorkflowId()));
55          return new ResolvedQualifiedRole(ROUTED_BY_USER_ROLE_LABEL, members);
56      }
57  }