org.sakaiproject.delegatedaccess.model

Class NodeModel

java.lang.Object

org.sakaiproject.delegatedaccess.model.NodeModel

All Implemented Interfaces:

Serializable

public class NodeModel
extends Object
implements Serializable

This is a Model object for each tree node. This helps store tree state information as well as get information for the node

Author:

Bryan Holladay (holladay@longsight.com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

NodeModel(String nodeId, HierarchyNodeSerialized node, boolean directAccess, String realm, String role, NodeModel parentNode, List<ListOptionSerialized> restrictedAuthTools, List<ListOptionSerialized> restrictedPublicTools, Date shoppingPeriodStartDate, Date shoppingPeriodEndDate, boolean addedDirectChildrenFlag, boolean shoppingPeriodAdmin, String modifiedBy, Date modified, Date shoppingAdminModified, String shoppingAdminModifiedBy, boolean accessAdmin, boolean shoppingPeriodRevokeInstructorEditable, boolean shoppingPeriodRevokeInstructorPublicOpt, boolean allowBecomeUser, boolean instructorEdited)

Method Summary

Modifier and Type	Method and Description
String[]	convertListToArray(List<ListOptionSerialized> list)
boolean	getInheritedAccessAdmin()
boolean	getInheritedAccessAdminHelper(NodeModel parent)
String[]	getInheritedAccessRealmRole()
boolean	getInheritedAllowBecomeUser()
boolean	getInheritedAllowBecomeUserHelper(NodeModel parent)
boolean	getInheritedNodeAccess()
boolean	getInheritedNodeAccessHelper(NodeModel parent)
List<ListOptionSerialized>	getInheritedRestrictedAuthTools()
List<ListOptionSerialized>	getInheritedRestrictedPublicTools()
boolean	getInheritedShoppingPeriodAdmin()
Date	getInheritedShoppingPeriodEndDate()
boolean	getInheritedShoppingPeriodRevokeInstructorEditable()
boolean	getInheritedShoppingPeriodRevokeInstructorEditableHelper(NodeModel parent)
boolean	getInheritedShoppingPeriodRevokeInstructorPublicOpt()
boolean	getInheritedShoppingPeriodRevokeInstructorPublicOptHelper(NodeModel parent)
Date	getInheritedShoppingPeriodStartDate()
String[]	getInheritedSubAdminSiteAccess()
String[]	getInheritedSubAdminSiteAccessHelper(NodeModel parent)
Date	getModified()
String	getModifiedBy()
HierarchyNodeSerialized	getNode()
boolean	getNodeAccess()
boolean	getNodeAccessAdmin()
String[]	getNodeAccessRealmRole() Will return the inherited role from it's parents and "" if not found
boolean	getNodeAllowBecomeUser()
String	getNodeId()
String[]	getNodeRestrictedAuthTools()
String[]	getNodeRestrictedPublicTools()
boolean	getNodeShoppingPeriodAdmin()
Date	getNodeShoppingPeriodEndDate()
boolean	getNodeShoppingPeriodRevokeInstructorEditable()
boolean	getNodeShoppingPeriodRevokeInstructorPublicOpt()
Date	getNodeShoppingPeriodStartDate()
String[]	getNodeSubAdminSiteAccess()
NodeModel	getParentNode()
String	getRealm()
List<ListOptionSerialized>	getRestrictedAuthTools()
List<ListOptionSerialized>	getRestrictedPublicTools()
String	getRole()
SelectOption	getRoleOption()
List<ListOptionSerialized>	getSelectedRestrictedAuthTools()
List<ListOptionSerialized>	getSelectedRestrictedAuthToolsOrig()
List<ListOptionSerialized>	getSelectedRestrictedPublicTools()
List<ListOptionSerialized>	getSelectedRestrictedPublicToolsOrig()
Date	getShoppingAdminModified()
String	getShoppingAdminModifiedBy()
Date	getShoppingPeriodEndDate()
Date	getShoppingPeriodStartDate()
String	getSiteInstructors()
String[]	getSubAdminSiteAccess()
boolean	hasAnyRestrictedAuthToolsSelected()
boolean	hasAnyRestrictedPublicToolsSelected()
boolean	isAccessAdmin()
boolean	isAccessAdminOrig()
boolean	isActive()
boolean	isAddedDirectChildrenFlag()
boolean	isAllowBecomeUser()
boolean	isAuthToolRestricted(String toolId)
boolean	isDirectAccess()
boolean	isDirectAccessOrig()
boolean	isEditable()
boolean	isInstructorEdited()
boolean	isModified()
boolean	isModified(Date shoppingStartDateOld, Date shoppingStartDateNew, Date shoppingEndDateOld, Date shoppingEndDateNew, String realmOld, String realmNew, String roleOld, String roleNew, String[] authToolsOld, String[] authToolsNew, String[] publicToolsOld, String[] publicToolsNew, boolean shoppingPeriodRevokeInstructorEditable, boolean shoppingPeriodRevokeInstructorEditableOrig, boolean shoppingPeriodRevokeInstructorPublicOpt, boolean shoppingPeriodRevokeInstructorPublicOptOrig, boolean allowBeomeUser, boolean allowBecomeUserOrig, boolean instructorEdited, boolean instructorEditedOrig)
boolean	isNodeEditable()
boolean	isPublicToolRestricted(String toolId)
boolean	isShoppingPeriodAdmin()
boolean	isShoppingPeriodAdminOrig()
boolean	isShoppingPeriodRevokeInstructorEditable()
boolean	isShoppingPeriodRevokeInstructorEditableOrig()
boolean	isShoppingPeriodRevokeInstructorPublicOpt()
boolean	isShoppingPeriodRevokeInstructorPublicOptOrig()
boolean	isSiteNode()
void	setAccessAdmin(boolean accessAdmin)
void	setAccessAdminOrig(boolean accessAdminOrig)
void	setActive(boolean isActive)
void	setAddedDirectChildrenFlag(boolean addedDirectChildrenFlag)
void	setAllowBecomeUser(boolean allowBecomeUser)
void	setAuthToolRestricted(String toolId, boolean restricted)
void	setDirectAccess(boolean directAccess)
void	setDirectAccessOrig(boolean directAccess)
void	setEditable(boolean editable)
void	setInstructorEdited(boolean instructorEdited)
void	setModified(Date modified)
void	setModifiedBy(String modifiedBy)
void	setNode(HierarchyNodeSerialized node)
void	setNodeId(String nodeId)
void	setOriginals() this function should be called after a save in order to reset the original values to their current value.
void	setParentNode(NodeModel parentNode)
void	setPublicToolRestricted(String toolId, boolean restricted)
void	setRealm(String realm)
void	setRestrictedAuthTools(List<ListOptionSerialized> restrictedAuthTools)
void	setRestrictedPublicTools(List<ListOptionSerialized> restrictedPublicTools)
void	setRole(String role)
void	setRoleOption(SelectOption roleOption)
void	setShoppingAdminModified(Date shoppingAdminModified)
void	setShoppingAdminModifiedBy(String shoppingAdminModifiedBy)
void	setShoppingPeriodAdmin(boolean shoppingPeriodAdmin)
void	setShoppingPeriodEndDate(Date shoppingPeriodEndDate)
void	setShoppingPeriodRevokeInstructorEditable(boolean shoppingPeriodRevokeInstructorEditable)
void	setShoppingPeriodRevokeInstructorEditableOrig(boolean shoppingPeriodRevokeInstructorEditableOrig)
void	setShoppingPeriodRevokeInstructorPublicOpt(boolean shoppingPeriodRevokeInstructorPublicOpt)
void	setShoppingPeriodRevokeInstructorPublicOptOrig(boolean shoppingPeriodRevokeInstructorPublicOptOrig)
void	setShoppingPeriodStartDate(Date shoppingPeriodStartDate)
void	setSiteInstructors(String siteInstructors)
void	setSubAdminSiteAccess(String[] subAdminSiteAccess)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeModel

public NodeModel(String nodeId,
                 HierarchyNodeSerialized node,
                 boolean directAccess,
                 String realm,
                 String role,
                 NodeModel parentNode,
                 List<ListOptionSerialized> restrictedAuthTools,
                 List<ListOptionSerialized> restrictedPublicTools,
                 Date shoppingPeriodStartDate,
                 Date shoppingPeriodEndDate,
                 boolean addedDirectChildrenFlag,
                 boolean shoppingPeriodAdmin,
                 String modifiedBy,
                 Date modified,
                 Date shoppingAdminModified,
                 String shoppingAdminModifiedBy,
                 boolean accessAdmin,
                 boolean shoppingPeriodRevokeInstructorEditable,
                 boolean shoppingPeriodRevokeInstructorPublicOpt,
                 boolean allowBecomeUser,
                 boolean instructorEdited)

Method Detail

setOriginals

public void setOriginals()

this function should be called after a save in order to reset the original values to their current value. By doing this, you allow the next save the check against the new values

getNodeId

public String getNodeId()

setNodeId

public void setNodeId(String nodeId)

getNode

public HierarchyNodeSerialized getNode()

setNode

public void setNode(HierarchyNodeSerialized node)

isDirectAccessOrig

public boolean isDirectAccessOrig()

setDirectAccessOrig

public void setDirectAccessOrig(boolean directAccess)

toString

public String toString()

Overrides:

toString in class Object

isDirectAccess

public boolean isDirectAccess()

setDirectAccess

public void setDirectAccess(boolean directAccess)

isModified

public boolean isModified()

isModified

public boolean isModified(Date shoppingStartDateOld,
                          Date shoppingStartDateNew,
                          Date shoppingEndDateOld,
                          Date shoppingEndDateNew,
                          String realmOld,
                          String realmNew,
                          String roleOld,
                          String roleNew,
                          String[] authToolsOld,
                          String[] authToolsNew,
                          String[] publicToolsOld,
                          String[] publicToolsNew,
                          boolean shoppingPeriodRevokeInstructorEditable,
                          boolean shoppingPeriodRevokeInstructorEditableOrig,
                          boolean shoppingPeriodRevokeInstructorPublicOpt,
                          boolean shoppingPeriodRevokeInstructorPublicOptOrig,
                          boolean allowBeomeUser,
                          boolean allowBecomeUserOrig,
                          boolean instructorEdited,
                          boolean instructorEditedOrig)

getRealm

public String getRealm()

setRealm

public void setRealm(String realm)

getRole

public String getRole()

setRole

public void setRole(String role)

getNodeAccessRealmRole

public String[] getNodeAccessRealmRole()

Will return the inherited role from it's parents and "" if not found

Returns:

getNodeShoppingPeriodStartDate

public Date getNodeShoppingPeriodStartDate()

getNodeShoppingPeriodEndDate

public Date getNodeShoppingPeriodEndDate()

getNodeAccess

public boolean getNodeAccess()

getInheritedNodeAccess

public boolean getInheritedNodeAccess()

getInheritedNodeAccessHelper

public boolean getInheritedNodeAccessHelper(NodeModel parent)

getInheritedAccessRealmRole

public String[] getInheritedAccessRealmRole()

getInheritedShoppingPeriodEndDate

public Date getInheritedShoppingPeriodEndDate()

getInheritedShoppingPeriodStartDate

public Date getInheritedShoppingPeriodStartDate()

getParentNode

public NodeModel getParentNode()

setParentNode

public void setParentNode(NodeModel parentNode)

getRestrictedAuthTools

public List<ListOptionSerialized> getRestrictedAuthTools()

setRestrictedAuthTools

public void setRestrictedAuthTools(List<ListOptionSerialized> restrictedAuthTools)

getNodeRestrictedAuthTools

public String[] getNodeRestrictedAuthTools()

convertListToArray

public String[] convertListToArray(List<ListOptionSerialized> list)

getInheritedRestrictedAuthTools

public List<ListOptionSerialized> getInheritedRestrictedAuthTools()

getSelectedRestrictedAuthTools

public List<ListOptionSerialized> getSelectedRestrictedAuthTools()

getSelectedRestrictedAuthToolsOrig

public List<ListOptionSerialized> getSelectedRestrictedAuthToolsOrig()

hasAnyRestrictedAuthToolsSelected

public boolean hasAnyRestrictedAuthToolsSelected()

setAuthToolRestricted

public void setAuthToolRestricted(String toolId,
                                  boolean restricted)

isAuthToolRestricted

public boolean isAuthToolRestricted(String toolId)

getRestrictedPublicTools

public List<ListOptionSerialized> getRestrictedPublicTools()

setRestrictedPublicTools

public void setRestrictedPublicTools(List<ListOptionSerialized> restrictedPublicTools)

getNodeRestrictedPublicTools

public String[] getNodeRestrictedPublicTools()

getInheritedRestrictedPublicTools

public List<ListOptionSerialized> getInheritedRestrictedPublicTools()

getSelectedRestrictedPublicTools

public List<ListOptionSerialized> getSelectedRestrictedPublicTools()

getSelectedRestrictedPublicToolsOrig

public List<ListOptionSerialized> getSelectedRestrictedPublicToolsOrig()

hasAnyRestrictedPublicToolsSelected

public boolean hasAnyRestrictedPublicToolsSelected()

setPublicToolRestricted

public void setPublicToolRestricted(String toolId,
                                    boolean restricted)

isPublicToolRestricted

public boolean isPublicToolRestricted(String toolId)

getShoppingPeriodStartDate

public Date getShoppingPeriodStartDate()

setShoppingPeriodStartDate

public void setShoppingPeriodStartDate(Date shoppingPeriodStartDate)

getShoppingPeriodEndDate

public Date getShoppingPeriodEndDate()

setShoppingPeriodEndDate

public void setShoppingPeriodEndDate(Date shoppingPeriodEndDate)

isAddedDirectChildrenFlag

public boolean isAddedDirectChildrenFlag()

setAddedDirectChildrenFlag

public void setAddedDirectChildrenFlag(boolean addedDirectChildrenFlag)

isShoppingPeriodAdmin

public boolean isShoppingPeriodAdmin()

isShoppingPeriodAdminOrig

public boolean isShoppingPeriodAdminOrig()

setShoppingPeriodAdmin

public void setShoppingPeriodAdmin(boolean shoppingPeriodAdmin)

getNodeShoppingPeriodAdmin

public boolean getNodeShoppingPeriodAdmin()

getInheritedShoppingPeriodAdmin

public boolean getInheritedShoppingPeriodAdmin()

getSiteInstructors

public String getSiteInstructors()

setSiteInstructors

public void setSiteInstructors(String siteInstructors)

getRoleOption

public SelectOption getRoleOption()

setRoleOption

public void setRoleOption(SelectOption roleOption)

getShoppingAdminModified

public Date getShoppingAdminModified()

setShoppingAdminModified

public void setShoppingAdminModified(Date shoppingAdminModified)

getShoppingAdminModifiedBy

public String getShoppingAdminModifiedBy()

setShoppingAdminModifiedBy

public void setShoppingAdminModifiedBy(String shoppingAdminModifiedBy)

getModified

public Date getModified()

setModified

public void setModified(Date modified)

getModifiedBy

public String getModifiedBy()

setModifiedBy

public void setModifiedBy(String modifiedBy)

isAccessAdmin

public boolean isAccessAdmin()

setAccessAdmin

public void setAccessAdmin(boolean accessAdmin)

isAccessAdminOrig

public boolean isAccessAdminOrig()

setAccessAdminOrig

public void setAccessAdminOrig(boolean accessAdminOrig)

getNodeAccessAdmin

public boolean getNodeAccessAdmin()

getInheritedAccessAdmin

public boolean getInheritedAccessAdmin()

getInheritedAccessAdminHelper

public boolean getInheritedAccessAdminHelper(NodeModel parent)

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean editable)

isNodeEditable

public boolean isNodeEditable()

isShoppingPeriodRevokeInstructorEditable

public boolean isShoppingPeriodRevokeInstructorEditable()

setShoppingPeriodRevokeInstructorEditable

public void setShoppingPeriodRevokeInstructorEditable(boolean shoppingPeriodRevokeInstructorEditable)

isShoppingPeriodRevokeInstructorEditableOrig

public boolean isShoppingPeriodRevokeInstructorEditableOrig()

setShoppingPeriodRevokeInstructorEditableOrig

public void setShoppingPeriodRevokeInstructorEditableOrig(boolean shoppingPeriodRevokeInstructorEditableOrig)

getNodeShoppingPeriodRevokeInstructorEditable

public boolean getNodeShoppingPeriodRevokeInstructorEditable()

getInheritedShoppingPeriodRevokeInstructorEditable

public boolean getInheritedShoppingPeriodRevokeInstructorEditable()

getInheritedShoppingPeriodRevokeInstructorEditableHelper

public boolean getInheritedShoppingPeriodRevokeInstructorEditableHelper(NodeModel parent)

isShoppingPeriodRevokeInstructorPublicOpt

public boolean isShoppingPeriodRevokeInstructorPublicOpt()

setShoppingPeriodRevokeInstructorPublicOpt

public void setShoppingPeriodRevokeInstructorPublicOpt(boolean shoppingPeriodRevokeInstructorPublicOpt)

isShoppingPeriodRevokeInstructorPublicOptOrig

public boolean isShoppingPeriodRevokeInstructorPublicOptOrig()

setShoppingPeriodRevokeInstructorPublicOptOrig

public void setShoppingPeriodRevokeInstructorPublicOptOrig(boolean shoppingPeriodRevokeInstructorPublicOptOrig)

getNodeShoppingPeriodRevokeInstructorPublicOpt

public boolean getNodeShoppingPeriodRevokeInstructorPublicOpt()

getInheritedShoppingPeriodRevokeInstructorPublicOpt

public boolean getInheritedShoppingPeriodRevokeInstructorPublicOpt()

getInheritedShoppingPeriodRevokeInstructorPublicOptHelper

public boolean getInheritedShoppingPeriodRevokeInstructorPublicOptHelper(NodeModel parent)

getSubAdminSiteAccess

public String[] getSubAdminSiteAccess()

setSubAdminSiteAccess

public void setSubAdminSiteAccess(String[] subAdminSiteAccess)

getInheritedSubAdminSiteAccess

public String[] getInheritedSubAdminSiteAccess()

getInheritedSubAdminSiteAccessHelper

public String[] getInheritedSubAdminSiteAccessHelper(NodeModel parent)

getNodeSubAdminSiteAccess

public String[] getNodeSubAdminSiteAccess()

setActive

public void setActive(boolean isActive)

isActive

public boolean isActive()

isSiteNode

public boolean isSiteNode()

isAllowBecomeUser

public boolean isAllowBecomeUser()

setAllowBecomeUser

public void setAllowBecomeUser(boolean allowBecomeUser)

getNodeAllowBecomeUser

public boolean getNodeAllowBecomeUser()

getInheritedAllowBecomeUser

public boolean getInheritedAllowBecomeUser()

getInheritedAllowBecomeUserHelper

public boolean getInheritedAllowBecomeUserHelper(NodeModel parent)

isInstructorEdited

public boolean isInstructorEdited()

setInstructorEdited

public void setInstructorEdited(boolean instructorEdited)