de.akrmoe.delivery
Interface GetDeliveryInformationLocal


public interface GetDeliveryInformationLocal

Diese API stellt Methoden zur Ermittlung von Lieferzeit-Information zu Möbel-Programmen sowie zur Ermittlung eines Lieferdatums zu einem Auftrag zur Verfuegung. Die Bean ist fuer die externe Verwendung in einem Web-Service gedacht. Die zugehoerige WSDL-Datei wird vom Framework generiert und mit der Dokumentation ausgeliefert.

Version:
1.1
Author:
Hayk Matthias, huelsta Werke

Field Summary
static java.lang.String APIVersion
          Aktuelle Version der API.
static int senderIdIsCustNo
           
static int senderIdIsGLN
           
 
Method Summary
 java.lang.String getApiVersion()
          Gibt die aktuelle Version der API-Implementierung des Web-Services zurueck
 DeliveryDate getDeliveryDate4Order(java.lang.String senderId, int senderIdType, java.lang.String recipientGLN, java.lang.String orderNumber, boolean numberDefinedBySender)
          Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) und der angegebenen Auftragsnummer den Liefertermin zurueckgibt.
 ProgramInformations getDeliveryTime4AllPrograms(java.lang.String senderId, int senderIdType, java.lang.String recipientGLN)
          Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) alle Programme und Lieferzeiten zurueck liefert.
 DeliveryTime getDeliveryTime4PrgGTIN(java.lang.String senderId, int senderIdType, java.lang.String recipientGLN, java.lang.String prgGTIN)
          Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) und das angegebene Programm (identifieziert ueber eine GTIN oder ehemals EAN) die Lieferzeit zurueckgibt.
 DeliveryTime getDeliveryTime4PrgName(java.lang.String senderId, int senderIdType, java.lang.String recipientGLN, java.lang.String prgName, boolean nameDefinedBySender)
          Methode die fuer den angegebenen Hersteller (recipientGLN) und den angegebenen Programm-Namen (oder herstellerabhaengig auch Programm-Kuerzel) die Lieferzeit zurueckgibt.
 ProgramInformations getInformations4AllPrograms(java.lang.String senderId, int senderIdType, java.lang.String recipientGLN, java.lang.String lngISO)
          Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) alle Programme und Programm-Informationen, sowie Lieferzeiten zurueck liefert.
 

Field Detail

APIVersion

static final java.lang.String APIVersion
Aktuelle Version der API.

See Also:
Constant Field Values

senderIdIsGLN

static final int senderIdIsGLN
See Also:
Constant Field Values

senderIdIsCustNo

static final int senderIdIsCustNo
See Also:
Constant Field Values
Method Detail

getDeliveryTime4PrgName

DeliveryTime getDeliveryTime4PrgName(java.lang.String senderId,
                                     int senderIdType,
                                     java.lang.String recipientGLN,
                                     java.lang.String prgName,
                                     boolean nameDefinedBySender)
Methode die fuer den angegebenen Hersteller (recipientGLN) und den angegebenen Programm-Namen (oder herstellerabhaengig auch Programm-Kuerzel) die Lieferzeit zurueckgibt. Fehler werden im Attribut errorMsg des Rueckgabe-Objektes zurueckgeliefert. Ansonsten wird dort ein "ok" geliefert falls der Aufruf erfolgreich war.

Parameters:
senderId - Id des die Information anfordernden Unternehmens. Kann GLN oder Kundennummer sein. Das wird ueber senderIdType signalisiert
senderIdType - 0(=senderIdIsGLN) senderId ist eine GLN, 1(=senderIsCustNo) senderId ist eine von recipientGLN abhaengige Kundennummer
recipientGLN - Hersteller bzw Vertriebsbereich des Herstellers von dem die Lieferzeit erfragt werden soll fuer ein Programm
prgName - Programm-Kuerzel fuer welches eine Lieferzeit erfragt wird
nameDefinedBySender - true=Den Namen des Programms hat der Sender(=Haendler) definiert, false=Den Name des Programms hat der Empfaenger(=Hersteller) definiert
Returns:
die Lieferzeit des Programms als Objekt der Klasse DeliveryTime
Since:
1.0

getDeliveryTime4PrgGTIN

DeliveryTime getDeliveryTime4PrgGTIN(java.lang.String senderId,
                                     int senderIdType,
                                     java.lang.String recipientGLN,
                                     java.lang.String prgGTIN)
Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) und das angegebene Programm (identifieziert ueber eine GTIN oder ehemals EAN) die Lieferzeit zurueckgibt. Fehler werden im Attribut errorMsg des Rueckgabe-Objektes zurueckgeliefert. Ansonsten wird dort ein "ok" geliefert falls der Aufruf erfolgreich war.

Parameters:
senderId - Id des die Information anfordernden Unternehmens. Kann GLN oder Kundennummer sein. Das wird ueber senderIdType signalisiert
senderIdType - 0(=senderIdIsGLN) senderId ist eine GLN, 1(=senderIsCustNo) senderId ist eine von recipientGLN abhaengige Kundennummer
recipientGLN - Hersteller bzw Vertriebsbereich des Herstellers von dem die Lieferzeit erfragt werden soll fuer ein Programm
GTIN - GTIN-Nummer des Programms fuer welches eine Lieferzeit erfragt wird.
Returns:
Lieferzeit als Objekt der Klasse DeliveryTime
Since:
1.0

getDeliveryDate4Order

DeliveryDate getDeliveryDate4Order(java.lang.String senderId,
                                   int senderIdType,
                                   java.lang.String recipientGLN,
                                   java.lang.String orderNumber,
                                   boolean numberDefinedBySender)
Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) und der angegebenen Auftragsnummer den Liefertermin zurueckgibt. Fehler werden im Attribut errorMsg zurueckgeliefert.

Parameters:
senderId - Id des die Information anfordernden Unternehmens. Kann GLN oder Kundennummer sein. Das wird ueber senderIdType signalisiert
senderIdType - 0(=senderIdIsGLN) senderId ist eine GLN, 1(=senderIsCustNo) senderId ist eine von recipientGLN abhaengige Kundennummer
recipientGLN - Hersteller bzw Vertriebsbereich des Herstellers von dem die Lieferzeit erfragt werden soll fuer ein Programm
orderNumber - Auftragsnummer
numberDefinedBySender - Auftragsnummer ist Auftragsnummer des Auftraggebers, also z.B. Bestellnummer, false=Auftragsnummer ist Auftragsnummer des Auftragsnehmers
Returns:
Lieferdatum als Objekt der Klasse DeliveryDate
Since:
1.1 Neues Attribut numberDefinedBySender

getDeliveryTime4AllPrograms

ProgramInformations getDeliveryTime4AllPrograms(java.lang.String senderId,
                                                int senderIdType,
                                                java.lang.String recipientGLN)
Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) alle Programme und Lieferzeiten zurueck liefert.

Parameters:
senderId - Id des die Information anfordernden Unternehmens. Kann GLN oder Kundennummer sein. Das wird ueber senderIdType signalisiert
senderIdType - 0(=senderIdIsGLN) senderId ist eine GLN, 1(=senderIsCustNo) senderId ist eine von recipientGLN abhaengige Kundennummer
recipientGLN - Hersteller bzw Vertriebsbereich des Herstellers von dem die Lieferzeit erfragt werden soll fuer ein Programm
Returns:
Liste mit Programm-Informationen. Jeweils Objekte vom Typ ProgramInfo. Die ihrerseits Objekte vom Type DeliveryTime beinhalten Sind Fehler aufgetreten wird (zunaechst) eine leere Liste zurueckgegeben.
Since:
1.0

getInformations4AllPrograms

ProgramInformations getInformations4AllPrograms(java.lang.String senderId,
                                                int senderIdType,
                                                java.lang.String recipientGLN,
                                                java.lang.String lngISO)
Methode die fuer den angegebenen Ziel-Hersteller (recipientGLN) alle Programme und Programm-Informationen, sowie Lieferzeiten zurueck liefert.

Parameters:
senderId - Id des die Information anfordernden Unternehmens. Kann GLN oder Kundennummer sein. Das wird ueber senderIdType signalisiert
senderIdType - 0(=senderIdIsGLN) senderId ist eine GLN, 1(=senderIsCustNo) senderId ist eine von recipientGLN abhaengige Kundennummer
recipientGLN - Hersteller bzw Vertriebsbereich des Herstellers von dem die Lieferzeit erfragt werden soll fuer ein Programm
lngISO - ISO-Code der Sprache mit dem Text-Informationen zum Programm angefordert werden (z.B. de=Deutsch,en=Englisch)
Returns:
Liste mit Programm-Informationen. Jeweils Objekte vom Typ ProgramInfo. Die ihrerseits Objekte vom Type DeliveryTime beinhalten Sind Fehler aufgetreten wird (zunaechst) eine leere Liste zurueckgegeben.
Since:
1.1 Methode neu zu dieser Version

getApiVersion

java.lang.String getApiVersion()
Gibt die aktuelle Version der API-Implementierung des Web-Services zurueck

Returns:
Version
Since:
1.0