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.19 $ $Date: 2006/08/28 09:12:33 $

Author:

Anthony Goubard

Constructor Summary

InvalidRequestResult()
Constructs a new InvalidRequestResult object.

Method Summary

void	addAttributeCombo(String type, List attributes, String elementName) Adds an invalid combination of attributes.
void	addInvalidValueForType(String parameter, String type) Adds an invalid value for a specified type.
void	addInvalidValueForType(String attribute, String type, String element) Adds an invalid value for a specified type.
void	addMissingParameter(String parameter) Adds to the response a paramater that is missing.
void	addMissingParameter(String attribute, String element) Adds to the response an attribute that is missing in an element.
void	addParamCombo(String type, List parameters) Adds an invalid combination of parameters.

Methods inherited from class org.xins.server.FunctionResult

add, add, checkOutputParameters, getDataElement, 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 a paramater that is missing.

Parameters:

parameter - the missing parameter.

addMissingParameter

public void addMissingParameter(String attribute,
                                String element)

Adds to the response an attribute that is missing in an element.

Parameters:

attribute - the missing attribute.

element - the element in which the attribute is missing.

addInvalidValueForType

public void addInvalidValueForType(String parameter,
                                   String type)

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 attribute,
                                   String type,
                                   String element)

Adds an invalid value for a specified type.

Parameters:

attribute - the attribute passed by the user.

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

element - the element in which the attribute is missing.

addParamCombo

public void addParamCombo(String type,
                          List 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 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