edu.internet2.middleware.grouper.rules
Class RuleCheck

java.lang.Object
  edu.internet2.middleware.grouper.rules.RuleCheck

public class RuleCheck
extends java.lang.Object

e.g. check: - type: flattenedMembershipChange - groups: X,Z the type of check and any params

Author:

mchyzer

Field Summary

static java.lang.String	FIELD_CHECK_ARG0 constant for field name for: checkArg0
static java.lang.String	FIELD_CHECK_ARG1 constant for field name for: checkArg1
static java.lang.String	FIELD_CHECK_OWNER_ID constant for field name for: checkOwnerId
static java.lang.String	FIELD_CHECK_OWNER_NAME constant for field name for: checkOwnerName
static java.lang.String	FIELD_CHECK_STEM_SCOPE constant for field name for: checkStemScope
static java.lang.String	FIELD_CHECK_TYPE constant for field name for: checkType

Constructor Summary

RuleCheck()

RuleCheck(java.lang.String type, java.lang.String ownerId, java.lang.String ownerName, java.lang.String theCheckStemScope, java.lang.String theCheckArg0, java.lang.String theCheckArg1)

Method Summary

void	addElVariables(RuleDefinition ruleDefinition, java.util.Map<java.lang.String,java.lang.Object> variableMap, RulesBean rulesBean, boolean hasAccessToElApi) add EL variables to the substitute map
RuleCheckType	checkTypeEnum() convert the type to an enum
RuleCheck	clone() deep clone the fields in this object
boolean	equals(java.lang.Object obj)
java.lang.String	getCheckArg0()
java.lang.String	getCheckArg1()
java.lang.String	getCheckOwnerId() group which fires the rule
java.lang.String	getCheckOwnerName() group/stem/etc which fires the rule
java.lang.String	getCheckStemScope() ALL or SUB
java.lang.String	getCheckType() type of rule check
int	hashCode()
void	setCheckArg0(java.lang.String _checkArg0)
void	setCheckArg1(java.lang.String _checkArg1)
void	setCheckOwnerId(java.lang.String group1) group which fires the rule
void	setCheckOwnerName(java.lang.String ownerName1) group/stem/etc which fires the rule
void	setCheckStemScope(java.lang.String checkStemScope1) ALL or SUB
void	setCheckType(java.lang.String type1) type of rule check
Stem.Scope	stemScopeEnum() convert the scope to an enum
java.lang.String	toString()
java.lang.String	validate(RuleDefinition ruleDefinition) validate this
java.lang.String	validateOwnerAttributeDef(RuleDefinition ruleDefinition) see if the owner is an attributeDef (note, owner requiredness not checked)
java.lang.String	validateOwnerGroup(RuleDefinition ruleDefinition) see if the owner is a group (note, owner requiredness not checked)
java.lang.String	validateOwnerStem(RuleDefinition ruleDefinition) see if the owner is a stem (note, owner requiredness not checked)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

FIELD_CHECK_ARG0

public static final java.lang.String FIELD_CHECK_ARG0

constant for field name for: checkArg0

See Also:

Constant Field Values

FIELD_CHECK_ARG1

public static final java.lang.String FIELD_CHECK_ARG1

constant for field name for: checkArg1

See Also:

Constant Field Values

FIELD_CHECK_OWNER_ID

public static final java.lang.String FIELD_CHECK_OWNER_ID

constant for field name for: checkOwnerId

See Also:

Constant Field Values

FIELD_CHECK_OWNER_NAME

public static final java.lang.String FIELD_CHECK_OWNER_NAME

constant for field name for: checkOwnerName

See Also:

Constant Field Values

FIELD_CHECK_STEM_SCOPE

public static final java.lang.String FIELD_CHECK_STEM_SCOPE

constant for field name for: checkStemScope

See Also:

Constant Field Values

FIELD_CHECK_TYPE

public static final java.lang.String FIELD_CHECK_TYPE

constant for field name for: checkType

See Also:

Constant Field Values

Constructor Detail

RuleCheck

public RuleCheck()

RuleCheck

public RuleCheck(java.lang.String type,
                 java.lang.String ownerId,
                 java.lang.String ownerName,
                 java.lang.String theCheckStemScope,
                 java.lang.String theCheckArg0,
                 java.lang.String theCheckArg1)

Parameters:

type -

ownerId -

ownerName -

theCheckStemScope -

theCheckArg0 -

theCheckArg1 -

Method Detail

clone

public RuleCheck clone()

deep clone the fields in this object

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

getCheckArg0

public java.lang.String getCheckArg0()

Returns:

the checkArg0

setCheckArg0

public void setCheckArg0(java.lang.String _checkArg0)

Parameters:

_checkArg0 - the checkArg0 to set

getCheckArg1

public java.lang.String getCheckArg1()

Returns:

the checkArg1

setCheckArg1

public void setCheckArg1(java.lang.String _checkArg1)

Parameters:

_checkArg1 - the checkArg1 to set

getCheckStemScope

public java.lang.String getCheckStemScope()

ALL or SUB

Returns:

the checkStemScope

setCheckStemScope

public void setCheckStemScope(java.lang.String checkStemScope1)

ALL or SUB

Parameters:

checkStemScope1 - the checkStemScope to set

getCheckOwnerName

public java.lang.String getCheckOwnerName()

group/stem/etc which fires the rule

Returns:

group/stem/etc which fires the rule

setCheckOwnerName

public void setCheckOwnerName(java.lang.String ownerName1)

group/stem/etc which fires the rule

Parameters:

ownerName1 -

getCheckType

public java.lang.String getCheckType()

type of rule check

Returns:

the type

setCheckType

public void setCheckType(java.lang.String type1)

type of rule check

Parameters:

type1 -

checkTypeEnum

public RuleCheckType checkTypeEnum()

convert the type to an enum

Returns:

rule check type

stemScopeEnum

public Stem.Scope stemScopeEnum()

convert the scope to an enum

Returns:

rule check scope

getCheckOwnerId

public java.lang.String getCheckOwnerId()

group which fires the rule

Returns:

the group

setCheckOwnerId

public void setCheckOwnerId(java.lang.String group1)

group which fires the rule

Parameters:

group1 -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

validate

public java.lang.String validate(RuleDefinition ruleDefinition)

validate this

Parameters:

ruleDefinition -

Returns:

error or null if ok

addElVariables

public void addElVariables(RuleDefinition ruleDefinition,
                           java.util.Map<java.lang.String,java.lang.Object> variableMap,
                           RulesBean rulesBean,
                           boolean hasAccessToElApi)

add EL variables to the substitute map

Parameters:

ruleDefinition -

variableMap -

rulesBean -

hasAccessToElApi -

validateOwnerGroup

public java.lang.String validateOwnerGroup(RuleDefinition ruleDefinition)

see if the owner is a group (note, owner requiredness not checked)

Parameters:

ruleDefinition -

Returns:

the error message

validateOwnerStem

public java.lang.String validateOwnerStem(RuleDefinition ruleDefinition)

see if the owner is a stem (note, owner requiredness not checked)

Parameters:

ruleDefinition -

Returns:

the error message

validateOwnerAttributeDef

public java.lang.String validateOwnerAttributeDef(RuleDefinition ruleDefinition)

see if the owner is an attributeDef (note, owner requiredness not checked)

Parameters:

ruleDefinition -

Returns:

the error message