cz.datalite.service.ares.AresService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of DLService Show documentation
Reusable services.
The newest version!
/*
 * Copyright 2009 (c) DataLite, spol. s r.o. All rights reserved.
 * Web: http://www.datalite.cz    Mail: [email protected]
 */

package cz.datalite.service.ares;

import cz.datalite.service.ares.exception.AresException;
import cz.datalite.service.ares.impl.AresServiceImpl;
import java.util.List;


/**
 * Služba pro zjištění informací z registru ARES.
 *
 * @author Jiri Bubnik
 * @see AresDotaz pro složení parametrů na dotaz do ARES
 * @see AresSubjekt ekonomický subjekt vrácený od ARES
 * @see AresServiceImpl implementace service přes GET parametry
 */
public interface AresService
{
    /**
     * Dotaz do hlavní databáze ARES pro zjištění subjektu.
     *
     * @param dotaz specifikace dotazu. Může se vyledávat podle IČO nebo názvu firmy.
     *          Pokud je IČO zadané, pokusí se najít firmu podle IČO a až když nic nanajde, zkusí vyhledávat podle názvu.
     *          V názvu je možné používat zástupné znaky * a ?. Název obce je pro dopřesnění vyhledávání podle názvu firmy
     *          a nemusí být zadán vůbec nebo stačí pouze část názvu.
     *
     * @return seznam nalezených subjektů.
     *
     * @throws AresException pokud dojde k chybě komunikace s registrem, nebo při zpracování XML. getMessage() obsahuje uživatelsky srozumitelný popis.
     */
    public List getAresEkonomickeSubjekty(AresDotaz dotaz) throws AresException;

    /**
     * DIČ je vedené v samostatném registru, proto se musí dotahovat samostatně dle IČO. Pokud je null, nemá firma DIČ přidělené.
     *
     * @param ico Celé IČO.
     * @return přidělené DIČ nebo null
     *
     * @throws AresException pokud dojde k chybě komunikace s registrem, nebo při zpracování XML. getMessage() obsahuje uživatelsky srozumitelný popis.
     */
    public String getAresDic(String ico) throws AresException;

    /**
     * DIČ je vedené v samostatném registru, proto se musí dotahovat samostatně dle IČO. Pokud je null, nemá firma DIČ přidělené.
     *
     * @param ico Celé IČO.
     * @return zápis u soudu a spisová značka
     *
     * @throws AresException pokud dojde k chybě komunikace s registrem, nebo při zpracování XML. getMessage() obsahuje uživatelsky srozumitelný popis.
     */
    public String getAresZapisVOR(String ico) throws AresException;
}