uPortal 2.4.1
API Documentation

org.jasig.portal.layout.restrictions
Class DepthRestriction

java.lang.Object
  extended byorg.jasig.portal.layout.restrictions.UserLayoutRestriction
      extended byorg.jasig.portal.layout.restrictions.DepthRestriction
All Implemented Interfaces:
IUserLayoutRestriction

public class DepthRestriction
extends UserLayoutRestriction

DepthRestriction checks the priority restriction for a given UserLayoutNode object.

Company: Instructional Media & Magic

Version:
$Revision: 1.7 $
Author:
Michael Ivanov

Field Summary
 
Fields inherited from class org.jasig.portal.layout.restrictions.UserLayoutRestriction
LOCAL_RESTRICTION
 
Constructor Summary
DepthRestriction()
           
DepthRestriction(java.lang.String nodePath)
           
 
Method Summary
 boolean checkRestriction(java.lang.String propertyValue)
          Checks the restriction for the specified node
 int getRestrictionType()
          Returns the type of the current restriction
 
Methods inherited from class org.jasig.portal.layout.restrictions.UserLayoutRestriction
checkRestriction, getRestrictionExpression, getRestrictionName, getRestrictionName, getRestrictionPath, setRestrictionExpression
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DepthRestriction

public DepthRestriction(java.lang.String nodePath)

DepthRestriction

public DepthRestriction()
Method Detail

getRestrictionType

public int getRestrictionType()
Returns the type of the current restriction

Specified by:
getRestrictionType in interface IUserLayoutRestriction
Overrides:
getRestrictionType in class UserLayoutRestriction
Returns:
a restriction type respresented in the RestrictionTypes interface

checkRestriction

public boolean checkRestriction(java.lang.String propertyValue)
                         throws PortalException
Checks the restriction for the specified node

Specified by:
checkRestriction in interface IUserLayoutRestriction
Specified by:
checkRestriction in class UserLayoutRestriction
Parameters:
propertyValue - a String property value to be checked
Throws:
PortalException

uPortal 2.4.1
API Documentation