uPortal 2.4.1
API Documentation

org.jasig.portal.layout.restrictions
Interface IUserLayoutRestriction

All Known Implementing Classes:
UserLayoutRestriction

public interface IUserLayoutRestriction

IUserLayoutRestriction is the base interface for UserLayout restrictions.

Version:
$Revision: 1.3 $
Author:
Michael Ivanov

Method Summary
 boolean checkRestriction(ALNode node)
          Checks the relative restriction on a given node
 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
 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
 

Method Detail

getRestrictionType

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

Returns:
a restriction type respresented in the RestrictionTypes interface

getRestrictionName

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

Returns:
a String restriction name

checkRestriction

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

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

Parameters:
node - a ALNode node
Returns:
a boolean value
Throws:
PortalException

setRestrictionExpression

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

Parameters:
restrictionExpression - a String expression

getRestrictionExpression

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

Returns:
a String expression

getRestrictionPath

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

Returns:
a String tree path

uPortal 2.4.1
API Documentation