edu.internet2.middleware.grouper.ws.coresoap
Class WsGroup

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.coresoap.WsGroup
All Implemented Interfaces:
java.lang.Comparable<WsGroup>

public class WsGroup
extends java.lang.Object
implements java.lang.Comparable<WsGroup>

Result of one group being retrieved since a user is a member of it. The number of groups will equal the number of groups the user is a member of (provided the filter matches)

Author:
mchyzer

Constructor Summary
WsGroup()
          no arg constructor
WsGroup(Group group, WsGroupLookup wsGroupLookup, boolean includeDetail)
          construct based on group, assign all fields
WsGroup(PITGroup pitGroup)
          construct based on pit group
 
Method Summary
 int compareTo(WsGroup o2)
           
static WsGroup[] convertGroups(java.util.Set<Group> groupSet, boolean includeDetail)
          convert a set of groups to results
static WsGroup[] convertGroups(java.util.Set<PITGroup> pitGroupSet)
          convert a set of pit groups to results
 java.lang.String getAlternateName()
           
 java.lang.String getDescription()
          friendly description of this group
 WsGroupDetail getDetail()
          if requested, these are the detail results of the group
 java.lang.String getDisplayExtension()
          display extension, the part to the right of the last colon in display name
 java.lang.String getDisplayName()
          friendly extensions of group and parent stems
 java.lang.String getExtension()
          extension of group, the part to the right of last colon in name
 java.lang.String getIdIndex()
          integer ID for object
 java.lang.String getName()
          Full name of the group (all extensions of parent stems, separated by colons, and the extention of this group
 java.lang.String getTypeOfGroup()
          type of group can be an enum of TypeOfGroup, e.g.
 java.lang.String getUuid()
          universally unique identifier of this group
 void setAlternateName(java.lang.String alternateName1)
           
 void setDescription(java.lang.String description1)
          friendly description of this group
 void setDetail(WsGroupDetail detail1)
          if requested, these are the detail results of the group
 void setDisplayExtension(java.lang.String displayExtension1)
          display extension, the part to the right of the last colon in display name
 void setDisplayName(java.lang.String displayName1)
          friendly extensions of group and parent stems
 void setExtension(java.lang.String extension1)
          extension of group, the part to the right of last colon in name
 void setIdIndex(java.lang.String idIndex1)
          integer ID for object
 void setName(java.lang.String name1)
          Full name of the group (all extensions of parent stems, separated by colons, and the extention of this group
 void setTypeOfGroup(java.lang.String typeOfGroup1)
          type of group can be an enum of TypeOfGroup, e.g.
 void setUuid(java.lang.String uuid1)
          universally unique identifier of this group
 java.lang.String toString()
          make sure this is an explicit toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsGroup

public WsGroup()
no arg constructor


WsGroup

public WsGroup(Group group,
               WsGroupLookup wsGroupLookup,
               boolean includeDetail)
construct based on group, assign all fields

Parameters:
group -
wsGroupLookup - is the lookup to set looked up values
includeDetail - true to include detail about group

WsGroup

public WsGroup(PITGroup pitGroup)
construct based on pit group

Parameters:
pitGroup -
Method Detail

toString

public java.lang.String toString()
make sure this is an explicit toString

Overrides:
toString in class java.lang.Object

getTypeOfGroup

public java.lang.String getTypeOfGroup()
type of group can be an enum of TypeOfGroup, e.g. group, role, entity

Returns:
type of group

setTypeOfGroup

public void setTypeOfGroup(java.lang.String typeOfGroup1)
type of group can be an enum of TypeOfGroup, e.g. group, role, entity

Parameters:
typeOfGroup1 -

convertGroups

public static WsGroup[] convertGroups(java.util.Set<Group> groupSet,
                                      boolean includeDetail)
convert a set of groups to results

Parameters:
groupSet -
includeDetail - true if detail of group should be sent
Returns:
the groups (null if none or null)

convertGroups

public static WsGroup[] convertGroups(java.util.Set<PITGroup> pitGroupSet)
convert a set of pit groups to results

Parameters:
pitGroupSet -
Returns:
the groups (null if none or null)

getIdIndex

public java.lang.String getIdIndex()
integer ID for object

Returns:
the id

setIdIndex

public void setIdIndex(java.lang.String idIndex1)
integer ID for object

Parameters:
idIndex1 -

getDescription

public java.lang.String getDescription()
friendly description of this group

Returns:
the description

getDisplayName

public java.lang.String getDisplayName()
friendly extensions of group and parent stems

Returns:
the displayName

getName

public java.lang.String getName()
Full name of the group (all extensions of parent stems, separated by colons, and the extention of this group

Returns:
the name

getUuid

public java.lang.String getUuid()
universally unique identifier of this group

Returns:
the uuid

setDescription

public void setDescription(java.lang.String description1)
friendly description of this group

Parameters:
description1 - the description to set

setDisplayName

public void setDisplayName(java.lang.String displayName1)
friendly extensions of group and parent stems

Parameters:
displayName1 - the displayName to set

setName

public void setName(java.lang.String name1)
Full name of the group (all extensions of parent stems, separated by colons, and the extention of this group

Parameters:
name1 - the name to set

setUuid

public void setUuid(java.lang.String uuid1)
universally unique identifier of this group

Parameters:
uuid1 - the uuid to set

getDetail

public WsGroupDetail getDetail()
if requested, these are the detail results of the group

Returns:
the detail

setDetail

public void setDetail(WsGroupDetail detail1)
if requested, these are the detail results of the group

Parameters:
detail1 - the detail to set

getExtension

public java.lang.String getExtension()
extension of group, the part to the right of last colon in name

Returns:
the extension

setExtension

public void setExtension(java.lang.String extension1)
extension of group, the part to the right of last colon in name

Parameters:
extension1 - the extension to set

getDisplayExtension

public java.lang.String getDisplayExtension()
display extension, the part to the right of the last colon in display name

Returns:
the displayExtension

setDisplayExtension

public void setDisplayExtension(java.lang.String displayExtension1)
display extension, the part to the right of the last colon in display name

Parameters:
displayExtension1 - the displayExtension to set

compareTo

public int compareTo(WsGroup o2)
Specified by:
compareTo in interface java.lang.Comparable<WsGroup>
See Also:
Comparable.compareTo(java.lang.Object)

getAlternateName

public java.lang.String getAlternateName()
Returns:
the alternateName

setAlternateName

public void setAlternateName(java.lang.String alternateName1)
Parameters:
alternateName1 - the alternateName to set