uPortal 2.4.1
API Documentation

org.jasig.portal.layout.restrictions
Class UserLayoutRestriction

java.lang.Object
  extended byorg.jasig.portal.layout.restrictions.UserLayoutRestriction
All Implemented Interfaces:
IUserLayoutRestriction
Direct Known Subclasses:
BooleanRestriction, DepthRestriction, GroupRestriction, PriorityRestriction

public abstract class UserLayoutRestriction
extends java.lang.Object
implements IUserLayoutRestriction

UserLayoutRelativeRestriction summary sentence goes here.

Version:
$Revision: 1.6 $
Author:
Michael Ivanov

Field Summary
static java.lang.String LOCAL_RESTRICTION
           
 
Constructor Summary
UserLayoutRestriction()
           
UserLayoutRestriction(java.lang.String nodePath)
           
 
Method Summary
 boolean checkRestriction(ALNode node)
          Checks the relative restriction on a given node
abstract  boolean checkRestriction(java.lang.String propertyValue)
          Checks the restriction for the given property value
 java.lang.String getRestrictionExpression()
          Gets the restriction expression
 java.lang.String getRestrictionName()
          Gets the restriction name
static java.lang.String getRestrictionName(int restrictionType, java.lang.String nodePath)
          Gets the restriction name based on a restriction type and a node path
 java.lang.String getRestrictionPath()
          Gets the tree path for the current restriction
 int getRestrictionType()
          Returns the type of the current restriction
 void setRestrictionExpression(java.lang.String restrictionExpression)
          Sets the restriction expression
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOCAL_RESTRICTION

public static java.lang.String LOCAL_RESTRICTION
Constructor Detail

UserLayoutRestriction

public UserLayoutRestriction()

UserLayoutRestriction

public UserLayoutRestriction(java.lang.String nodePath)
Method Detail

checkRestriction

public abstract boolean checkRestriction(java.lang.String propertyValue)
                                  throws PortalException
Checks the restriction for the given property value

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

checkRestriction

public boolean checkRestriction(ALNode node)
                         throws PortalException
Checks the relative restriction on a given node

Specified by:
checkRestriction in interface IUserLayoutRestriction
Parameters:
node - a ALNode node
Returns:
a boolean value
Throws:
PortalException

getRestrictionType

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

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

getRestrictionName

public java.lang.String getRestrictionName()
Gets the restriction name

Specified by:
getRestrictionName in interface IUserLayoutRestriction
Returns:
a String restriction name

getRestrictionName

public static java.lang.String getRestrictionName(int restrictionType,
                                                  java.lang.String nodePath)
Gets the restriction name based on a restriction type and a node path

Parameters:
restrictionType - a restriction type
nodePath - a String node path
Returns:
a String restriction name

setRestrictionExpression

public void setRestrictionExpression(java.lang.String restrictionExpression)
Sets the restriction expression

Specified by:
setRestrictionExpression in interface IUserLayoutRestriction
Parameters:
restrictionExpression - a String expression

getRestrictionExpression

public java.lang.String getRestrictionExpression()
Gets the restriction expression

Specified by:
getRestrictionExpression in interface IUserLayoutRestriction
Returns:
a String expression

getRestrictionPath

public java.lang.String getRestrictionPath()
Gets the tree path for the current restriction

Specified by:
getRestrictionPath in interface IUserLayoutRestriction
Returns:
a String tree path

uPortal 2.4.1
API Documentation