org.esupportail.portal.channels.CWebdav.userManagement
Class Group

java.lang.Object
  extended byorg.esupportail.portal.channels.CWebdav.userManagement.Group

public class Group
extends java.lang.Object

Id: Group.java,v 1.0 7 oct. 2004 Copyright (c) 2004 Esup Portail (www.esup-portail.org) Classes: Group Original Author: Yohan Colmant Represents a group for the management


Field Summary
private  java.lang.String displayName
          The displayed user name
private  java.util.Vector groupHierarchy
          This group hierarchy
private  java.lang.String key
          The group key
protected static org.apache.commons.logging.Log log
          Logger object
 
Constructor Summary
Group(org.jasig.portal.groups.EntityGroupImpl group)
          Constructor
Group(java.lang.String hierarchy)
          Constructor
Group(java.lang.String key, java.lang.String displayName)
          Constructor
 
Method Summary
 boolean equals(java.lang.Object o)
          Check if this group equals the object given in parameter
 java.lang.String getDisplayName()
          Get the group display name
 java.util.Vector getGroupHierarchy()
          Get this group keys hierarchy from the root to the group key
private  java.lang.String getGroupName(java.lang.String groupKey)
          Get the display name for the group key specified in parameter
 java.lang.String getKey()
          Get this group key
private  void recurGroupHierarchy(org.jasig.portal.groups.IGroupMember igm, java.util.Vector v)
          Set recursivly the group hierarchy
 void setDisplayName(java.lang.String displayName)
          Set the group display name
private  void setGroupHierarchy(org.jasig.portal.groups.EntityGroupImpl group)
          Set this group hierarchy
 java.lang.String toString()
          Return a String from this group
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

protected static final org.apache.commons.logging.Log log
Logger object


displayName

private java.lang.String displayName
The displayed user name


key

private java.lang.String key
The group key


groupHierarchy

private java.util.Vector groupHierarchy
This group hierarchy

Constructor Detail

Group

public Group(java.lang.String key,
             java.lang.String displayName)
Constructor

Parameters:
key - the group key
displayName - The displayed group name

Group

public Group(org.jasig.portal.groups.EntityGroupImpl group)
      throws org.jasig.portal.groups.GroupsException
Constructor

Parameters:
group - this portal group value

Group

public Group(java.lang.String hierarchy)
      throws org.jasig.portal.groups.GroupsException
Constructor

Parameters:
hierarchy - this portal group hierarchy in this form: G1/G2/G3 where G1 is the root
Throws:
org.jasig.portal.groups.GroupsException
Method Detail

getGroupName

private java.lang.String getGroupName(java.lang.String groupKey)
                               throws org.jasig.portal.groups.GroupsException
Get the display name for the group key specified in parameter

Parameters:
groupKey - the group key
Returns:
the display name
Throws:
org.jasig.portal.groups.GroupsException

setGroupHierarchy

private void setGroupHierarchy(org.jasig.portal.groups.EntityGroupImpl group)
                        throws org.jasig.portal.groups.GroupsException
Set this group hierarchy

Parameters:
group - the group to explore
Throws:
org.jasig.portal.groups.GroupsException

recurGroupHierarchy

private void recurGroupHierarchy(org.jasig.portal.groups.IGroupMember igm,
                                 java.util.Vector v)
                          throws org.jasig.portal.groups.GroupsException
Set recursivly the group hierarchy

Parameters:
igm - the group member object
v - the vector we want to set
Throws:
org.jasig.portal.groups.GroupsException

getDisplayName

public java.lang.String getDisplayName()
Get the group display name

Returns:
Returns the displayName.

setDisplayName

public void setDisplayName(java.lang.String displayName)
Set the group display name

Parameters:
displayName - The displayName to set.

getKey

public java.lang.String getKey()
Get this group key

Returns:
Returns the key.

getGroupHierarchy

public java.util.Vector getGroupHierarchy()
Get this group keys hierarchy from the root to the group key

Returns:
a vector construct with each hierarchy node

equals

public boolean equals(java.lang.Object o)
Check if this group equals the object given in parameter

Parameters:
o - the object to compare
Returns:
true if equals, false else

toString

public java.lang.String toString()
Return a String from this group

Returns:
a String from this group