|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.restrictions.UserLayoutRestriction
public abstract class UserLayoutRestriction
UserLayoutRestriction summary sentence goes here.
Field Summary | |
---|---|
private java.lang.String |
name
|
protected java.lang.String |
nodePath
|
private java.lang.String |
restrictionExpression
|
Fields inherited from interface org.jasig.portal.layout.restrictions.IUserLayoutRestriction |
---|
CHILDREN_RESTRICTION_PATH, LOCAL_RESTRICTION_PATH, PARENT_RESTRICTION_PATH |
Constructor Summary | |
---|---|
UserLayoutRestriction()
|
|
UserLayoutRestriction(java.lang.String name)
|
|
UserLayoutRestriction(java.lang.String name,
java.lang.String nodePath)
|
Method Summary | |
---|---|
boolean |
checkRestriction(ILayoutNode node)
Checks the restriction on a given node |
abstract boolean |
checkRestriction(java.lang.String propertyValue)
Checks the restriction for the given property value |
java.lang.String |
getName()
Returns the name of the current restriction |
java.lang.String |
getRestrictionExpression()
Gets the restriction expression |
java.lang.String |
getRestrictionPath()
Gets the tree path for the current restriction |
java.lang.String |
getUniqueKey()
Gets the restriction name |
static java.lang.String |
getUniqueKey(java.lang.String restrictionName)
Gets the local restriction name based on a restriction type |
static java.lang.String |
getUniqueKey(java.lang.String restrictionName,
java.lang.String nodePath)
Gets the restriction name based on a restriction name and a node path |
protected abstract void |
parseRestrictionExpression()
Parses the restriction expression of the current node |
void |
setName(java.lang.String name)
Sets the name of the current restriction |
void |
setRestrictionExpression(java.lang.String restrictionExpression)
Sets the restriction expression |
void |
setRestrictionPath(java.lang.String nodePath)
Sets the restriction path |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.lang.String name
private java.lang.String restrictionExpression
protected java.lang.String nodePath
Constructor Detail |
---|
public UserLayoutRestriction()
public UserLayoutRestriction(java.lang.String name)
public UserLayoutRestriction(java.lang.String name, java.lang.String nodePath)
Method Detail |
---|
public void setName(java.lang.String name)
setName
in interface IUserLayoutRestriction
a
- String
namepublic java.lang.String getName()
getName
in interface IUserLayoutRestriction
String
namepublic void setRestrictionPath(java.lang.String nodePath)
setRestrictionPath
in interface IUserLayoutRestriction
restrictionPath
- a String
pathprotected abstract void parseRestrictionExpression() throws PortalException
PortalException
public abstract boolean checkRestriction(java.lang.String propertyValue) throws PortalException
checkRestriction
in interface IUserLayoutRestriction
propertyValue
- a String
property value to be checked
PortalException
public boolean checkRestriction(ILayoutNode node) throws PortalException
checkRestriction
in interface IUserLayoutRestriction
node
- a ILayoutNode
node
PortalException
public java.lang.String getUniqueKey()
getUniqueKey
in interface IUserLayoutRestriction
String
restriction namepublic static java.lang.String getUniqueKey(java.lang.String restrictionName, java.lang.String nodePath)
restrictionName
- a restriction namenodePath
- a String
node path
String
restriction namepublic static java.lang.String getUniqueKey(java.lang.String restrictionName)
restrictionName
- a restriction name
String
restriction namepublic void setRestrictionExpression(java.lang.String restrictionExpression)
setRestrictionExpression
in interface IUserLayoutRestriction
restrictionExpression
- a String
expressionpublic java.lang.String getRestrictionExpression()
getRestrictionExpression
in interface IUserLayoutRestriction
String
expressionpublic java.lang.String getRestrictionPath()
getRestrictionPath
in interface IUserLayoutRestriction
String
tree path
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |