View Javadoc

1   /*
2    * Copyright 2005-2008 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.dto;
18  
19  
20  /**
21   * Represents a revocation of an AdHoc request.<br><br>
22   * 
23   * Each of the fields represents criteria for revoking requests.  If necessary, they can be
24   * combined.  For example, if you specify a userId and a nodeName it will indicate that the
25   * requests for the user at that node will need to be revoked.<br><br>
26   * 
27   * <ol>
28   *   <li><b>actionRequestId</b> - the ID of the action request to revoke</li>
29   *   <li><b>userId</b> - the ID of the user whose request(s) should be revoked</li>
30   * 	 <li><b>groupId</b> - the ID of the group whose requests(s) should be revoked</li>
31   *   <li><b>nodeName</b> - the name of the node to revoke requests at</li>
32   * </ol>
33   * 
34   * @author Kuali Rice Team (rice.collab@kuali.org)
35   */
36  public class AdHocRevokeDTO implements java.io.Serializable {
37  
38  	private static final long serialVersionUID = 7650456194747488114L;
39  
40  	private String actionRequestId;
41  	private String nodeName;
42  	private String principalId;
43  	private String groupId;
44  	
45  	public AdHocRevokeDTO() {}
46  	
47  	// TODO: KULRICE-5329 - verify that this is in fact no longer used anyway  
48  //	public AdHocRevokeDTO(Long actionRequestId) {
49  //		this.actionRequestId = actionRequestId;
50  //	}
51  		
52  	public AdHocRevokeDTO(String nodeName) {
53  		this.nodeName = nodeName;
54  	}
55  
56  	public String getActionRequestId() {
57  		return actionRequestId;
58  	}
59  
60  	public void setActionRequestId(String actionRequestId) {
61  		this.actionRequestId = actionRequestId;
62  	}
63  
64  	public String getNodeName() {
65  		return nodeName;
66  	}
67  
68  	public void setNodeName(String nodeName) {
69  		this.nodeName = nodeName;
70  	}
71  
72  	public String getPrincipalId() {
73  		return this.principalId;
74  	}
75  
76  	public void setPrincipalId(String principalId) {
77  		this.principalId = principalId;
78  	}
79  
80  	public String getGroupId() {
81  		return this.groupId;
82  	}
83  
84  	public void setGroupId(String groupId) {
85  		this.groupId = groupId;
86  	}	
87  
88  }