org.xins.server

Class InvalidRequestResult

java.lang.Object

org.xins.server.FunctionResult

org.xins.server.InvalidRequestResult

public class InvalidRequestResult
extends FunctionResult

Result code that indicates that an input parameter is either missing or invalid.

Since:

XINS 1.0.0

Version:

$Revision: 1.27 $ $Date: 2010/09/29 17:21:48 $

Author:

Anthony Goubard

Constructor Summary

Constructors

Constructor and Description
InvalidRequestResult() Constructs a new InvalidRequestResult object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeCombo(String type, List<String> attributes, String elementName) Adds an invalid combination of attributes.
void	addInvalidValueForType(String parameter, String type) Deprecated. since XINS 2.0, use addInvalidValueForType(String, String, String).
void	addInvalidValueForType(String parameter, String value, String type) Adds an invalid value for a specified type.
void	addInvalidValueForType(String parameter, String value, String type, String element) Adds an invalid value for a specified type.
void	addMissingParameter(String parameter) Adds to the response that a paramater that is missing.
void	addMissingParameter(String parameter, String element) Adds to the response a parameter that is missing in an element.
void	addParamCombo(String type, List<String> parameters) Adds an invalid combination of parameters.

Methods inherited from class org.xins.server.FunctionResult

add, checkOutputParameters, getDataElement, getDataElementBuilder, getErrorCode, getParameter, getParameters, param, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidRequestResult

public InvalidRequestResult()

Constructs a new InvalidRequestResult object.

Method Detail

addMissingParameter

public void addMissingParameter(String parameter)

Adds to the response that a paramater that is missing.

Parameters:

parameter - the missing parameter.

addMissingParameter

public void addMissingParameter(String parameter,
                       String element)

Adds to the response a parameter that is missing in an element.

Parameters:

parameter - the missing parameter.

element - the element in which the parameter is missing.

addInvalidValueForType

public void addInvalidValueForType(String parameter,
                          String type)

Deprecated. since XINS 2.0, use addInvalidValueForType(String, String, String).

Adds an invalid value for a specified type.

Parameters:

parameter - the parameter passed by the user.

type - the type which this parameter should be compliant with.

addInvalidValueForType

public void addInvalidValueForType(String parameter,
                          String value,
                          String type)

Adds an invalid value for a specified type.

Parameters:

parameter - the parameter passed by the user.

value - the value of the parameter passed by the user.

type - the type which this parameter should be compliant with.

addInvalidValueForType

public void addInvalidValueForType(String parameter,
                          String value,
                          String type,
                          String element)

Adds an invalid value for a specified type.

Parameters:

parameter - the parameter passed by the user.

value - the value of the parameter passed by the user.

type - the type which this parameter should be compliant with.

element - the element in which the parameter is missing.

addParamCombo

public void addParamCombo(String type,
                 List<String> parameters)

Adds an invalid combination of parameters.

Parameters:

type - the type of the combination.

parameters - list of the parameters in the combination passed as a list of String objects.

addAttributeCombo

public void addAttributeCombo(String type,
                     List<String> attributes,
                     String elementName)

Adds an invalid combination of attributes.

Parameters:

type - the type of the combination.

attributes - list of the attributes in the combination passed as a list of String objects.

elementName - the name of the element to which these attributes belong.

Since:

XINS 1.4.0