//
// SwitchRMI  Framework
// Copyright (c) 2000-2002 by Michael J. Henderson & Associates.
//
// Michael Henderson
// http://switchrmi.sf.net
// mailto:mikehenderson@dunelm.org.uk
//
// This library is free software.
//
// You may redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License as published by the Free Software Foundation.
//
// Version 2.1 of the license should be included with this distribution in
// the file LICENSE, as well as License.html. If the license is not
// included with this distribution, you may find a copy at the FSF web
// site at 'www.gnu.org' or 'www.fsf.org', or you may write to the
// Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139 USA.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied waranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// $Id: IValidator.java,v 1.1 2002/11/11 22:19:48 mikehenderson Exp $
package com.mjh.switchrmi.protocol.xmlrpc.validator;

import java.util.Date;
import java.util.List;
import java.util.Map;

/*
validator1.arrayOfStructsTest (array) returns number
This handler takes a single parameter, an array of structs, each of which contains at least three elements named moe, larry and curly, all <i4>s.
Your handler must add all the struct elements named curly and return the result.

validator1.countTheEntities (string) returns struct
This handler takes a single parameter, a string, that contains any number of predefined entities, namely <, >, &, ' and ".
Your handler must return a struct that contains five fields, all numbers: ctLeftAngleBrackets, ctRightAngleBrackets, ctAmpersands, ctApostrophes, ctQuotes. 
To validate, the numbers must be correct.

validator1.easyStructTest (struct) returns number
This handler takes a single parameter, a struct, containing at least three elements named moe, larry and curly, all <i4>s.
Your handler must add the three numbers and return the result.

validator1.echoStructTest (struct) returns struct
This handler takes a single parameter, a struct. Your handler must return the struct.

validator1.manyTypesTest (number, boolean, string, double, dateTime, base64) returns array
This handler takes six parameters, and returns an array containing all the parameters.

validator1.moderateSizeArrayCheck (array) returns string
This handler takes a single parameter, which is an array containing between 100 and 200 elements.
Each of the items is a string, your handler must return a string containing the concatenated text of the first and last elements.

validator1.nestedStructTest (struct) returns number
This handler takes a single parameter, a struct, that models a daily calendar.
At the top level, there is one struct for each year. Each year is broken down into months, and months into days.
Most of the days are empty in the struct you receive, but the entry for April 1, 2000 contains a least three elements named moe, larry and curly, all <i4>s.
Your handler must add the three numbers and return the result.

Ken MacLeod: "This description isn't clear, I expected '2000.April.1' when in fact it's '2000.04.01'.
Adding a note saying that month and day are two-digits with leading 0s, and January is 01 would help." Done.

validator1.simpleStructReturnTest (number) returns struct
This handler takes one parameter, and returns a struct containing three elements, times10, times100 and times1000, the result of multiplying the number by 10, 100 and 1000.


*/
public interface IValidator
{
    public int arrayOfStructsTest(List list);

    public Map countTheEntities(String string);

    public int easyStructTest(Map map);

    public Map echoStructTest(Map map);

    public List manyTypesTest(int number, boolean bool, String string, 
                              double dbl, Date date, byte[] base64);

    public String moderateSizeArrayCheck(List list);

    public int nestedStructTest(Map map);

    public Map simpleStructReturnTest(int number);
}