com.edgeti.VisibilityServer.UsersAndRoles

Class RoleInfoObject

java.lang.Object

com.edgeti.VisibilityServer.UsersAndRoles.RoleInfoObject

public class RoleInfoObject
extends java.lang.Object

Class that holds role information in Visibility hierarchy. Exists as a Java and matching Flex object

Author:

phil.feldman

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<RoleInfoObject>	children The children.
private int	id The id.
private java.lang.String	name The name.
private RoleInfoObject	parent The parent.
private int	parentId The parent id.
private java.util.List<TableInfoObject>	tables The tables.
private java.util.List<UserInfoObject>	users The users.

Constructor Summary

Constructors

Constructor and Description
RoleInfoObject() Empty Ctor for Flex.
RoleInfoObject(java.lang.String name, int id, int parentId) Create the node given the name, id, and parentId.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBranchToList(java.util.List<RoleInfoObject> branchlist) Get this RoleNode and all child nodes below it.
void	addBranchToMap(java.util.Map<java.lang.String,RoleInfoObject> branchMap) Add this RoleNode once and all unique child nodes below it to a Map
void	addChild(RoleInfoObject child) Add a RoleNode child to this RoleNode.
RoleInfoObject	deepCopy() Deep copy.
void	delete() Delete.
boolean	equals(RoleInfoObject rio) Equals.
RoleInfoObject	findChildById(int id) Go down the branches below this node looking for a child that has the given id.
java.util.List<RoleInfoObject>	getChildren() Get all the RoleNodes that are children of this RoleNode.
java.lang.String	getFullName() Gets the full name.
int	getId() Get the ID of this RoleNode.
java.lang.String	getName() Get the name of this RoleNode.
RoleInfoObject	getParent() Get the RoleNode that is the parent of this RoleNode.
int	getParentId() Get the id of the parent of this RoleNode.
void	getRoleHierarchyAbove(java.util.List<java.lang.String> parentList) Get a list of the names of all the RoleNodes that exist above this RoleNode in a direct line towards the root.
void	getRoleHierarchyBelow(java.util.List<java.lang.String> childList) Get a list of the names of all the RoleNodes that exist below this RoleNode (i.e.
void	getRoleHierarchyBelowById(java.util.List<java.lang.Integer> childList) Get a list of the id's of all the RoleNodes that exist below this RoleNode (i.e.
java.util.List<TableInfoObject>	getTables() Gets the tables.
java.util.List<UserInfoObject>	getUsers() Gets the users.
boolean	isRoleAbove(RoleInfoObject lowRole) Checks if is role above.
void	setChildren(java.util.List<RoleInfoObject> children) Set the List of all the RoleNodes that are children of this RoleNode.
void	setId(int id) Sets the id.
void	setName(java.lang.String name) Sets the name.
void	setParent(RoleInfoObject parent) Set the RoleNode that is the parent of this RoleNode.
void	setParentId(int parentId) Set the id of the parent of this RoleNode.
void	setTables(java.util.List<TableInfoObject> tables) Sets the tables.
void	setUsers(java.util.List<UserInfoObject> users) Sets the users.
void	toFlexTree(FlexTreeObject ftoParent) Return the hierarchy as a tree.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

parent

private RoleInfoObject parent

The parent.

children

private java.util.List<RoleInfoObject> children

The children.

id

private int id

The id.

parentId

private int parentId

The parent id.

name

private java.lang.String name

The name.

users

private java.util.List<UserInfoObject> users

The users.

tables

private java.util.List<TableInfoObject> tables

The tables.

Constructor Detail

RoleInfoObject

public RoleInfoObject()

Empty Ctor for Flex.

RoleInfoObject

public RoleInfoObject(java.lang.String name,
              int id,
              int parentId)

Create the node given the name, id, and parentId. The full hierarchy is not determined at this point, but rather when addChild() and setParent are called

Parameters:

name - the name

id - the id

parentId - the parent id

Method Detail

setParent

public void setParent(RoleInfoObject parent)

Set the RoleNode that is the parent of this RoleNode.

Parameters:

parent - the new parent

getParent

public RoleInfoObject getParent()

Get the RoleNode that is the parent of this RoleNode.

Returns:

the parent RoleInfoObject

getChildren

public java.util.List<RoleInfoObject> getChildren()

Get all the RoleNodes that are children of this RoleNode.

Returns:

the children as List

addBranchToList

public void addBranchToList(java.util.List<RoleInfoObject> branchlist)

Get this RoleNode and all child nodes below it.

Parameters:

branchlist - the branchlist that will be appended

addBranchToMap

public void addBranchToMap(java.util.Map<java.lang.String,RoleInfoObject> branchMap)

Add this RoleNode once and all unique child nodes below it to a Map

Parameters:

branchMap - the branch map to append

deepCopy

public RoleInfoObject deepCopy()

Deep copy.

Returns:

the copied role info object

setChildren

public void setChildren(java.util.List<RoleInfoObject> children)

Set the List of all the RoleNodes that are children of this RoleNode. Note that this is by reference.

Parameters:

children - the new children

getId

public int getId()

Get the ID of this RoleNode.

Returns:

the id

setId

public void setId(int id)

Sets the id.

Parameters:

id - the new id

getParentId

public int getParentId()

Get the id of the parent of this RoleNode.

Returns:

the parent id

setParentId

public void setParentId(int parentId)

Set the id of the parent of this RoleNode.

Parameters:

parentId - the new parent id

getName

public java.lang.String getName()

Get the name of this RoleNode.

Returns:

the name

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

addChild

public void addChild(RoleInfoObject child)

Add a RoleNode child to this RoleNode.

Parameters:

child - the child

delete

public void delete()

Delete.

findChildById

public RoleInfoObject findChildById(int id)

Go down the branches below this node looking for a child that has the given id.

Parameters:

id - the id

Returns:

the role info object

isRoleAbove

public boolean isRoleAbove(RoleInfoObject lowRole)

Checks if is role above.

Parameters:

lowRole - the low role

Returns:

true, if is role above

getRoleHierarchyBelow

public void getRoleHierarchyBelow(java.util.List<java.lang.String> childList)

Get a list of the names of all the RoleNodes that exist below this RoleNode (i.e. leafwise)

Parameters:

the - List childList to append

getRoleHierarchyBelowById

public void getRoleHierarchyBelowById(java.util.List<java.lang.Integer> childList)

Get a list of the id's of all the RoleNodes that exist below this RoleNode (i.e. leafwise)

Parameters:

the - List childList to append

getRoleHierarchyAbove

public void getRoleHierarchyAbove(java.util.List<java.lang.String> parentList)

Get a list of the names of all the RoleNodes that exist above this RoleNode in a direct line towards the root.

Parameters:

the - List parentList to append

getFullName

public java.lang.String getFullName()

Gets the full name.

Returns:

the full name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(RoleInfoObject rio)

Equals.

Parameters:

rio - the RoleInfoObject

Returns:

true if((rio.id == id)&&(rio.parentId == parentId)&&(rio.name.equals(name)))

toFlexTree

public void toFlexTree(FlexTreeObject ftoParent)

Return the hierarchy as a tree.

Parameters:

ftoParent - the FlexTreeObject to populate

getUsers

public java.util.List<UserInfoObject> getUsers()

Gets the users.

Returns:

the users

setUsers

public void setUsers(java.util.List<UserInfoObject> users)

Sets the users.

Parameters:

users - the new users

getTables

public java.util.List<TableInfoObject> getTables()

Gets the tables.

Returns:

the tables

setTables

public void setTables(java.util.List<TableInfoObject> tables)

Sets the tables.

Parameters:

tables - the new tables