View Javadoc

1   /**
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.uif.container;
17  
18  import org.kuali.rice.krad.uif.component.ComponentSecurity;
19  
20  /**
21   * Collection Group security is used to flag that permissions exist for the associated {@link CollectionGroup}
22   * in KIM and should be checked to determine the associated group, line, and field state. In particular this adds
23   * the edit line and view line flags
24   *
25   * <p>
26   * In addition, properties such as additional role and permission details can be configured to use when
27   * checking the KIM permissions
28   * </p>
29   *
30   * @author Kuali Rice Team (rice.collab@kuali.org)
31   */
32  public class CollectionGroupSecurity extends ComponentSecurity {
33      private static final long serialVersionUID = 1134455196763917062L;
34  
35      private boolean editLineAuthz;
36      private boolean viewLineAuthz;
37  
38      public CollectionGroupSecurity() {
39          super();
40  
41          editLineAuthz = false;
42          viewLineAuthz = false;
43      }
44  
45      /**
46       * Indicates whether the collection group line has edit authorization and KIM should be consulted
47       *
48       * @return boolean true if the line has edit authorization, false if not
49       */
50      public boolean isEditLineAuthz() {
51          return editLineAuthz;
52      }
53  
54      /**
55       * Setter for the edit line authorization flag
56       *
57       * @param editLineAuthz
58       */
59      public void setEditLineAuthz(boolean editLineAuthz) {
60          this.editLineAuthz = editLineAuthz;
61      }
62  
63      /**
64       * Indicates whether the collection group line has view authorization and KIM should be consulted
65       *
66       * @return boolean true if the line has view authorization, false if not
67       */
68      public boolean isViewLineAuthz() {
69          return viewLineAuthz;
70      }
71  
72      /**
73       * Setter for the view line authorization flag
74       *
75       * @param viewLineAuthz
76       */
77      public void setViewLineAuthz(boolean viewLineAuthz) {
78          this.viewLineAuthz = viewLineAuthz;
79      }
80  
81  }