Package com.highdeal.hci

Class CheckPasswordResult

java.lang.Object

com.highdeal.hci.CheckPasswordResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

Direct Known Subclasses:

CheckUserPasswordResult

public class CheckPasswordResult
extends Object
implements OperationResult

This operation result contains the list of all the rules which are not satisfied by the new password specified in the CheckPasswordOp operation request.

Operation Request

CheckPasswordOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="checkPasswordResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="passwordRule" minOccurs="0" maxOccurs="unbounded" />
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckPasswordResult.PasswordRule	This model represents the result of the check of a rule against a password.
static enum	CheckPasswordResult.PasswordRuleId	This enumeration specifies all possible rule identifiers of the unsatisfied rules that apply to passwords.

Constructor Summary

Constructors

Constructor	Description
CheckPasswordResult()	Builds an empty password check result.

Method Summary

Modifier and Type	Method	Description
void	addCharacterData(String data)	Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child)	Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getOperandReference()	Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
List<CheckPasswordResult.PasswordRule>	getPasswordRules()	Gets a list containing the result of the check of the password rules for the specified password.
void	marshal(XMLOutputter output)	Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts)	Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CheckPasswordResult

public CheckPasswordResult()

Builds an empty password check result.

Method Details

getPasswordRules

public List<CheckPasswordResult.PasswordRule> getPasswordRules()

Gets a list containing the result of the check of the password rules for the specified password.

Returns:

A list containing the result of the check of the password rules for the specified password

getOperandReference

public String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the operation result

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(String tagName,
 XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(String data)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

data - The character data to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into