View Javadoc
1   /*******************************************************************************
2    * Copyright 2012 Internet2
3    * 
4    * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
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  /**
17   * 
18   */
19  package edu.internet2.middleware.grouper.ws.soap;
20  
21  
22  /**
23   * Result of one group being retrieved since a user is a member of it.  The number of
24   * groups will equal the number of groups the user is a member of (provided the filter matches)
25   * 
26   * @author mchyzer
27   */
28  public class WsGroup {
29  
30    /** extension of group, the part to the right of last colon in name */
31    private String extension;
32  
33    /** display extension, the part to the right of the last colon in display name */
34    private String displayExtension;
35  
36    /**
37     * friendly description of this group
38     */
39    private String description;
40  
41    /**
42     * friendly extensions of group and parent stems
43     */
44    private String displayName;
45  
46    /**
47     * Full name of the group (all extensions of parent stems, separated by colons,  and the extention of this group
48     */
49    private String name;
50  
51    /**
52     * universally unique identifier of this group
53     */
54    private String uuid;
55  
56    /**
57     * if requested, return the detail properties of the group
58     */
59    private WsGroupDetail detail;
60  
61    /**
62     * no arg constructor
63     */
64    public WsGroup() {
65      //blank
66  
67    }
68  
69    /**
70     * friendly description of this group
71     * @return the description
72     */
73    public String getDescription() {
74      return this.description;
75    }
76  
77    /**
78     * friendly extensions of group and parent stems
79     * @return the displayName
80     */
81    public String getDisplayName() {
82      return this.displayName;
83    }
84  
85    /**
86     * Full name of the group (all extensions of parent stems, separated by colons, 
87     * and the extention of this group
88     * @return the name
89     */
90    public String getName() {
91      return this.name;
92    }
93  
94    /**
95     * universally unique identifier of this group
96     * @return the uuid
97     */
98    public String getUuid() {
99      return this.uuid;
100   }
101 
102   /**
103    * friendly description of this group
104    * @param description1 the description to set
105    */
106   public void setDescription(String description1) {
107     this.description = description1;
108   }
109 
110   /**
111    * friendly extensions of group and parent stems
112    * @param displayName1 the displayName to set
113    */
114   public void setDisplayName(String displayName1) {
115     this.displayName = displayName1;
116   }
117 
118   /**
119    * Full name of the group (all extensions of parent stems, separated by colons, 
120    * and the extention of this group
121    * @param name1 the name to set
122    */
123   public void setName(String name1) {
124     this.name = name1;
125   }
126 
127   /**
128    * universally unique identifier of this group
129    * @param uuid1 the uuid to set
130    */
131   public void setUuid(String uuid1) {
132     this.uuid = uuid1;
133   }
134 
135   /**
136    * if requested, these are the detail results of the group
137    * @return the detail
138    */
139   public WsGroupDetail getDetail() {
140     return this.detail;
141   }
142 
143   /**
144    * if requested, these are the detail results of the group
145    * @param detail1 the detail to set
146    */
147   public void setDetail(WsGroupDetail detail1) {
148     this.detail = detail1;
149   }
150 
151   /**
152    * extension of group, the part to the right of last colon in name
153    * @return the extension
154    */
155   public String getExtension() {
156     return this.extension;
157   }
158 
159   /**
160    * extension of group, the part to the right of last colon in name
161    * @param extension1 the extension to set
162    */
163   public void setExtension(String extension1) {
164     this.extension = extension1;
165   }
166 
167   /**
168    * display extension, the part to the right of the last colon in display name
169    * @return the displayExtension
170    */
171   public String getDisplayExtension() {
172     return this.displayExtension;
173   }
174 
175   /**
176    * display extension, the part to the right of the last colon in display name
177    * @param displayExtension1 the displayExtension to set
178    */
179   public void setDisplayExtension(String displayExtension1) {
180     this.displayExtension = displayExtension1;
181   }
182 }