domain.ice

/*
 * MIT License
 *
 * Copyright (c) 2020 Eduardo Alvarez , Alvaro Castillo , Ignacio Fuenzalida
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */


// https://doc.zeroc.com/ice/3.7/language-mappings/java-mapping/client-side-slice-to-java-mapping/customizing-the-java-mapping
["cs:namespace:ParkingUcn.ZeroIce","java:package:cl.ucn.disc.pdis.parkingucn.zeroice"]
module model {


    /**
    * Categoria de la persona
    */
    enum CategoriaPersona {
        FUNCIONARIO,ACADEMICO,ESTUDIANTE
    }

    /**
    * Sexo de la persona
    */
    enum Sexo {
        VAR,MUJ,OTHER
    }
    
    /**
    * Estado del vehiculo
    * IN: Vehiculo dentro del campus
    * OUT: Vehiculo fuera del campus
    */
    enum Location {
        OUT,IN
    }
    
    /**
     * Lugar de acceso del vehiculo
     */
    enum Porteria {
         SUR, MANCILLA, SANGRA
     }


    /**
     * Class Persona
     */
    ["cs:property"]
    class Persona{

        /**
         * Primary Key
         */
        int uid;

        /**
         * Run: 189725965
         */
        string run;

        /**
         * Nombre
         */
        string nombre;

        /**
         * Sexo de la persona
         */
        Sexo sexo;

        /**
         * Unidad perteneciente.
         */
        string unidad;

        /**
         * email
         */
        string email;

        /**
         * Telefono movil
         */
        string telefonoMovil;

        /**
         * Telefono fijo
         */
        string telefonoFijo;

        /**
        * Categoria de la persona
        */
        CategoriaPersona categoriaPersona;


    }

    /**
     * Class vehiculo
     */
    ["cs:property"]
    class Vehiculo{

        /**
         * Primary Key
         */
        int uid;

        /**
         * Patente del vehiculo
         */
        string patente;

        /**
         * Marca vehiculo
         */
        string marca;  

        /**
         * Modelo del vehiculo
         */
        string modelo;

        /**
         * Año del vehiculo
         */
        int anio;

        /**
         * Obervaciones
         */
        string observaciones;

        /**
         * Duenio del vehiculo.
         */
        string runDuenio;
        
        /**
         * Lugar, dentro/fuera del campus
         */
        Location location;
        
    }

    /**
     * Registro acceso de vehiculos.
     */
    ["cs:property"]
    class Acceso {

        /** 
         * Id 
         */
        int uid;
        
        /** 
         * Timestamp
         */
        string horaEntrada;
        
        /** 
         * Patente del vehiculo 
         */
        string patente;
        
        /**
         * Lugar de acceso
         */
        Porteria porteria;

    }
    
    
    
    /**
     * Listas de vehiculos.
     */
    sequence<Vehiculo> Vehiculos;    
    
    /**
     * Listas de Accesos.
     */
    sequence<Acceso> Accesos;
    
    /**
     * Listas de Personas.
     */
    sequence<Persona> Personas;


    
    exception RunRelationNotFoundException
    {
        string reason = "ForeyKey run not found on the persona table";
    }    
    exception NotFoundException
    {
        string reason = "information not found on the system's database";
    }
    exception DuplicateDataException
    {
        string reason = "information already exist on the system's database";
    }
    exception NotAuthorizedException
    {
        string reason = "the operation can't be authorized";
        Location location;
    }
    exception ServerException 
    {
        string reason = "internal error server doesn't connect to database ";
    }
    
    /**
     * Interfaz de los Contratos
     */
    interface Contratos {
    
            
        /**
         * Registra el acceso de algun vehiculo.
         * @param patente identificador unico del vehiculo.
         * @param porteria indica la porteria de entrada.
         * @return Acceso confirmada la entrada/salida en el sistema, se retornan los datos del vehiculo.
         */
        Acceso autorizarVehiculo(string patente, Porteria porteria)
            throws ServerException;
        
        /**
         * Obtener todos los vehiculos de la bd.
         * @return Vehiculos secuencia de objetos de tipo vehiculo.
         * @throws ServerException error interno del servidor.
         */
        Vehiculos obtenerVehiculos()
            throws ServerException;
            
        /**
         * Devuelve todas las personas en la base de datos
         * @return Personas from database
         * @throws ServerException error interno del servidor.
         */
        Personas obtenerPersonas()	
            throws ServerException;
    
    
    }

    
    /**
    * Interfaz del sistema
    */
    interface TheSystem {


        /**
         * Registrar una nueva persona en el sistema.
         * @param Persona datos de la persona.
         * @return Persona se retornan los datos ingresados en el sistema como confirmacion.
         * @throws DuplicateDataException la informacion ingresada ya existe en el sistema.
         */
        Persona registrarPersona(Persona persona)
            throws DuplicateDataException, ServerException;

        /**
         * Eliminar una persona del sistema.
         * @param run identificador unico de la persona.
         * @return Persona se retornan los datos eliminados en el sistema como confirmacion.
         * @throws NotFoundException si la informacion ingresada no existe.
         */
        Persona eliminarPersona(string run)
            throws ServerException;

        /**
         * Editar una persona del sistema.
         * @param Persona datos actualiados de la persona.
         * @return Persona se retornan los datos cambiados en el sistema como confirmacion.
         */
        Persona editarPersona(Persona persona)
            throws ServerException;

        /**
         * Registrar un nuevo vehiculo en el sistema
         * @param Vehiculo datos del vehiculo
         * @return Vehiculo se retornan los datos ingresados en el sistema como confirmacion.
         * @throws DuplicateDataException la informacion ingresada ya existe en el sistema.
         */
        Vehiculo registrarVehiculo(Vehiculo vehiculo)
            throws DuplicateDataException, RunRelationNotFoundException , ServerException;

        /**
         * Eliminar un vehiculo del sistema.
         * @param patente identificador unico del vehiculo.
         * @return Vehiculo se retornan los datos eliminados en el sistema como confirmacion.
         * @throws NotFoundException si la informacion ingresada no existe.
         */
        Vehiculo eliminarVehiculo(string patente)
            throws ServerException;

        /**
         * Editar un vehiculo del sistema.
         * @param Vehiculo datos actualiados del vehiculo.
         * @return Vehiculo se retornan los datos cambiados en el sistema como confirmacion.
         */
        Vehiculo editarVehiculo(Vehiculo vehiculo)
        throws ServerException;
	
    /**
	* Devuelve del delay entre el cliente y el server
	* @param Tiempo del cliente
	* @return delay entre cliente/servidor
	*/
	long getDelay(long time)
	throws ServerException;

	/**
	* Obtiene una Persona dado un rut
	* @param rut 
	* @return Persona by rut
	*/
	Persona getPersona(string rut)
	throws ServerException;

	/**
	* Obtiene un Vehiculo dado un patente
	* @param Vehiculo 
	* @return Vehiculo by patente
	*/
	Vehiculo getVehiculo(string patente)
	throws ServerException;
	
	/**
    * Devuelve todos los accesos en la base de datos
    * @return Accesos from database
    **/
    Accesos getAllAccess()	
    throws ServerException;
    /**
    * Devuelve todas las personas en la base de datos
    * @return Personas from database
    **/
    Personas getAllPersonas()	
    throws ServerException;

    /**
    * Devuelve todos las vehiculos en la base de datos
    * @return Vehiculos from database
    **/
    Vehiculos getAllVehiculos()	
    throws ServerException;        
    }
    

}