Package ndg :: Package xacml :: Package core :: Package context :: Module result :: Class Status
[hide private]

Class Status

source code

   object --+        
            |        
XacmlCoreBase --+    
                |    
 XacmlContextBase --+
                    |
                   Status

XACML Response Result Status

Instance Methods [hide private]
 
__init__(self, **kw)
ELEMENT_LOCAL_NAME check makes this class virtual - derived classes must override this method and set ELEMENT_LOCAL_NAME to the appropriate string
source code
ndg.xacml.core.context.StatusCode
_getStatusCode(self)
Gets the Code of this Status.
source code
 
_setStatusCode(self, value)
Sets the Code of this Status.
source code
basestring
_getStatusMessage(self)
Gets the Message of this Status.
source code
 
_setStatusMessage(self, value)
Sets the Message of this Status.
source code
any
_getStatusDetail(self)
Gets the Detail of this Status.
source code
 
_setStatusDetail(self, value)
Sets the Detail of this Status.
source code

Inherited from XacmlContextBase: __getstate__, __setstate__

Inherited from XacmlCoreBase (private): _getXmlns, _setXmlns

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

Class Methods [hide private]
ndg.xacml.core.context.Status
createInitialised(cls, code='urn:oasis:names:tc:xacml:1.0:status:ok', message='', detail='')
Create with an empty StatusCode object set
source code
Class Variables [hide private]
NoneType but implement as string in derived classes ELEMENT_LOCAL_NAME = 'Status'
XML element local name for the given type

Inherited from XacmlContextBase: XACML_2_0_CONTEXT_NS, XACML_2_0_CONTEXT_NS_PREFIX

Inherited from XacmlCoreBase: XACML_1_0_NS_PREFIX, XACML_2_0_NS_PREFIX, XMLNS

Instance Variables [hide private]
None / ndg.xacml.core.context.result.StatusCode __statusCode
Status code element
None / any type __statusDetail
Status detail element
None / basestring __statusMessage
Status message element
Properties [hide private]
  statusCode
status code object
  statusMessage
status message
  statusDetail
status message

Inherited from XacmlCoreBase: elem, isValidXmlns, xmlns

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kw)
(Constructor)

source code 

ELEMENT_LOCAL_NAME check makes this class virtual - derived classes must override this method and set ELEMENT_LOCAL_NAME to the appropriate string

Raises:
  • NotImplementedError - derived classes must set ELEMENT_LOCAL_NAME to a string
Overrides: object.__init__
(inherited documentation)

createInitialised(cls, code='urn:oasis:names:tc:xacml:1.0:status:ok', message='', detail='')
Class Method

source code 

Create with an empty StatusCode object set

Parameters:
  • code (basestring) - Status code - defaults to OK code
  • message (basestring) - Status Message
  • detail (string / any) - Status detail
Returns: ndg.xacml.core.context.Status
Status instance

_getStatusCode(self)

source code 

Gets the Code of this Status.

Returns: ndg.xacml.core.context.StatusCode
Status StatusCode

_setStatusCode(self, value)

source code 

Sets the Code of this Status.

Parameters:
  • value (ndg.xacml.core.context.StatusCode) - the Code of this Status

_getStatusMessage(self)

source code 

Gets the Message of this Status.

Returns: basestring
Status StatusMessage

_setStatusMessage(self, value)

source code 

Sets the Message of this Status.

Parameters:
  • value (basestring) - the Message of this Status

_getStatusDetail(self)

source code 

Gets the Detail of this Status.

Returns: any
Status detail

_setStatusDetail(self, value)

source code 

Sets the Detail of this Status.

Parameters:
  • value (any type) - the Detail of this Status

Property Details [hide private]

statusCode

status code object

Get Method:
_getStatusCode(self) - Gets the Code of this Status.
Set Method:
_setStatusCode(self, value) - Sets the Code of this Status.

statusMessage

status message

Get Method:
_getStatusMessage(self) - Gets the Message of this Status.
Set Method:
_setStatusMessage(self, value) - Sets the Message of this Status.

statusDetail

status message

Get Method:
_getStatusDetail(self) - Gets the Detail of this Status.
Set Method:
_setStatusDetail(self, value) - Sets the Detail of this Status.