Package ndg :: Package xacml :: Package core :: Module obligation :: Class Effect
[hide private]

Class Effect

source code

object --+
         |
        Effect

Define effect type for Obligation

Instance Methods [hide private]
 
__init__(self, effectType)
Initialise attributes giving an effect type
source code
dict
__getstate__(self)
Enable pickling
source code
 
__setstate__(self, attrDict)
Enable pickling
source code
 
_setValue(self, value)
Set effect
source code
ndg.xacml.core.obligation.Effect
_getValue(self)
Get effect
source code
basestring
__str__(self)
Returns: effect as a string
source code
 
__eq__(self, effect) source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
string PERMIT_STR = 'Permit'
permit decision string
string DENY_STR = 'Deny'
deny decision string
tuple TYPES = ('Permit', 'Deny')
list of valid effect strings
Instance Variables [hide private]
  __value
obligation effect
Properties [hide private]
  value
Effect value

Inherited from object: __class__

Method Details [hide private]

__init__(self, effectType)
(Constructor)

source code 

Initialise attributes giving an effect type

Parameters:
  • effectType ()
Overrides: object.__init__

__getstate__(self)

source code 

Enable pickling

Returns: dict
instance attributes dictionary

__setstate__(self, attrDict)

source code 

Enable pickling

Parameters:
  • attrDict (dict) - instance attributes dictionary

_setValue(self, value)

source code 

Set effect

Parameters:
  • value (ndg.xacml.core.obligation.Effect or basestring) - effect
Raises:
  • TypeError - incorrect type for input
  • AttributeError - effect value not recognised

_getValue(self)

source code 

Get effect

Returns: ndg.xacml.core.obligation.Effect
effect value

__str__(self)
(Informal representation operator)

source code 

str(x)

Returns: basestring
effect as a string
Overrides: object.__str__

__eq__(self, effect)
(Equality operator)

source code 
Parameters:
  • effect - ndg.xacml.core.obligation.Effect or basestring
Raises:
  • TypeError - incorrect type for input
  • AttributeError - effect value not recognised

Property Details [hide private]

value

Effect value

Get Method:
_getValue(self) - Get effect
Set Method:
_setValue(self, value) - Set effect