uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Class ALNode

java.lang.Object
  extended byorg.jasig.portal.layout.ALNode
Direct Known Subclasses:
ALChannel, ALFolder

public abstract class ALNode
extends java.lang.Object

IALNode summary sentence goes here.

Company: Instructional Media & Magic

Version:
$Revision: 1.11 $
Author:
Michael Ivanov

Constructor Summary
ALNode()
           
ALNode(IALNodeDescription nd)
           
 
Method Summary
static ALNode createALNode(IUserLayoutNodeDescription nodeDescription)
           
static IALNodeDescription createUserLayoutNodeDescription(org.w3c.dom.Element xmlNode)
          A factory method to create a IALNodeDescription instance, based on the information provided in the user layout Element.
 java.lang.String getFragmentId()
           
 java.lang.String getFragmentNodeId()
           
 java.lang.String getId()
           
 java.lang.String getNextNodeId()
           
 IALNodeDescription getNodeDescription()
           
abstract  int getNodeType()
          Gets the node type
 java.lang.String getParentNodeId()
           
 java.lang.String getPreviousNodeId()
           
 int getPriority()
          Gets the priority value for this node.
 IUserLayoutRestriction getRestriction(java.lang.String restrictionName)
          Gets a restriction by the type.
 java.util.Vector getRestrictionsByPath(java.lang.String restrictionPath)
          Gets a restrictions list by a restriction path.
 void setNextNodeId(java.lang.String nextNodeId)
           
 void setNodeDescription(IALNodeDescription nd)
           
 void setParentNodeId(java.lang.String parentNodeId)
           
 void setPreviousNodeId(java.lang.String previousNodeId)
           
 void setPriority(int priority)
          Sets the priority for this node.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ALNode

public ALNode()

ALNode

public ALNode(IALNodeDescription nd)
Method Detail

getId

public java.lang.String getId()

getFragmentId

public java.lang.String getFragmentId()

getFragmentNodeId

public java.lang.String getFragmentNodeId()

getNodeType

public abstract int getNodeType()
Gets the node type

Returns:
a node type

setNodeDescription

public void setNodeDescription(IALNodeDescription nd)

getNodeDescription

public IALNodeDescription getNodeDescription()

setParentNodeId

public void setParentNodeId(java.lang.String parentNodeId)

getParentNodeId

public java.lang.String getParentNodeId()

setNextNodeId

public void setNextNodeId(java.lang.String nextNodeId)

getNextNodeId

public java.lang.String getNextNodeId()

setPreviousNodeId

public void setPreviousNodeId(java.lang.String previousNodeId)

getPreviousNodeId

public java.lang.String getPreviousNodeId()

setPriority

public void setPriority(int priority)
Sets the priority for this node.

Parameters:
priority - a int priority value

getPriority

public int getPriority()
Gets the priority value for this node.


getRestriction

public IUserLayoutRestriction getRestriction(java.lang.String restrictionName)
Gets a restriction by the type.

Parameters:
restrictionName - a String name of the restriction
Returns:
a IUserLayoutRestriction

getRestrictionsByPath

public java.util.Vector getRestrictionsByPath(java.lang.String restrictionPath)
Gets a restrictions list by a restriction path.

Parameters:
restrictionPath - a String restriction path
Returns:
a IUserLayoutRestriction

createUserLayoutNodeDescription

public static IALNodeDescription createUserLayoutNodeDescription(org.w3c.dom.Element xmlNode)
                                                          throws PortalException
A factory method to create a IALNodeDescription instance, based on the information provided in the user layout Element.

Parameters:
xmlNode - a user layout DTD folder/channel Element value
Returns:
an IALNodeDescription value
Throws:
PortalException - if the xml passed is somehow invalid.

createALNode

public static ALNode createALNode(IUserLayoutNodeDescription nodeDescription)
                           throws PortalException
Throws:
PortalException

uPortal 2.4.1
API Documentation