edu.internet2.middleware.grouper.membership
Class MembershipPath

java.lang.Object
  extended by edu.internet2.middleware.grouper.membership.MembershipPath
All Implemented Interfaces:
Comparable<MembershipPath>

public class MembershipPath
extends Object
implements Comparable<MembershipPath>

path of a membership for a subject in a group, group privilege, stem privilege, or attribute privilege. these are distinct paths from start to finish, if there are multiple subpaths, each will expand into a full path

Author:
mchyzer

Constructor Summary
MembershipPath()
          default constructor
MembershipPath(Member member1, List<MembershipPathNode> membershipPathNodes1, MembershipType theMembershipType)
          construct with fields
 
Method Summary
 int compareTo(MembershipPath membershipPath)
           
 boolean equalsExceptFields(MembershipPath that)
          see if it is the same path except the field
 Set<Field> getFields()
          field for this path, generally one for list, or multiple for privileges
 Set<Field> getFieldsIncludingImplied()
          fields assigned, and the fields those fields imply
 Member getMember()
          member in the membership
 List<MembershipPathNode> getMembershipPathNodes()
          ordered list of nodes for this membership path
 MembershipType getMembershipType()
          IMMEDIATE or EFFECTIVE, etc
 boolean isPathAllowed()
          if path allowed to be seen by user
 void setFields(Set<Field> fields)
          field for this path, generally one for list, or multiple for privileges
 void setFieldsIncludingImplied(Set<Field> fieldsIncludingImplied)
          fields assigned, and the fields those fields imply
 void setMember(Member member1)
          member in the membership
 void setMembershipPathNodes(List<MembershipPathNode> membershipPathNodes1)
          ordered list of nodes for this membership path
 void setMembershipType(MembershipType membershipType1)
          IMMEDIATE or EFFECTIVE, etc
 void setPathAllowed(boolean thePathAllowed1)
          if path allowed to be seen by user
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MembershipPath

public MembershipPath()
default constructor


MembershipPath

public MembershipPath(Member member1,
                      List<MembershipPathNode> membershipPathNodes1,
                      MembershipType theMembershipType)
construct with fields

Parameters:
member1 -
membershipPathNodes1 -
theMembershipType -
Method Detail

getFieldsIncludingImplied

public Set<Field> getFieldsIncludingImplied()
fields assigned, and the fields those fields imply

Returns:
the fieldsIncludingImplied

setFieldsIncludingImplied

public void setFieldsIncludingImplied(Set<Field> fieldsIncludingImplied)
fields assigned, and the fields those fields imply

Parameters:
fieldsIncludingImplied - the fieldsIncludingImplied to set

getFields

public Set<Field> getFields()
field for this path, generally one for list, or multiple for privileges

Returns:
the fields

setFields

public void setFields(Set<Field> fields)
field for this path, generally one for list, or multiple for privileges

Parameters:
fields -

getMember

public Member getMember()
member in the membership

Returns:
the member

setMember

public void setMember(Member member1)
member in the membership

Parameters:
member1 -

equalsExceptFields

public boolean equalsExceptFields(MembershipPath that)
see if it is the same path except the field

Parameters:
that -
Returns:
if same path

getMembershipPathNodes

public List<MembershipPathNode> getMembershipPathNodes()
ordered list of nodes for this membership path

Returns:
list of membership path nodes

setMembershipPathNodes

public void setMembershipPathNodes(List<MembershipPathNode> membershipPathNodes1)
ordered list of nodes for this membership path

Parameters:
membershipPathNodes1 -

toString

public String toString()
Overrides:
toString in class Object
See Also:
Object.toString()

compareTo

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

getMembershipType

public MembershipType getMembershipType()
IMMEDIATE or EFFECTIVE, etc

Returns:
membership type

setMembershipType

public void setMembershipType(MembershipType membershipType1)
IMMEDIATE or EFFECTIVE, etc

Parameters:
membershipType1 -

isPathAllowed

public boolean isPathAllowed()
if path allowed to be seen by user

Returns:
path allowed

setPathAllowed

public void setPathAllowed(boolean thePathAllowed1)
if path allowed to be seen by user

Parameters:
thePathAllowed1 -