palio.modules
Class Allegro

java.lang.Object
  extended by palio.modules.core.Module
      extended by palio.modules.Allegro
All Implemented Interfaces:
palio.modules.core.CurrentModuleDataKeys

public final class Allegro
extends palio.modules.core.Module

jPalio'wy interfejs do Allegro WebAPI.

Moduł jest dostępny po dodaniu do pliku konfiguracyjnego instancji.

Version:
0.9.1
Author:
Mateusz Gembarzewski

Field Summary
 
Fields inherited from interface palio.modules.core.CurrentModuleDataKeys
DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT
 
Constructor Summary
Allegro(palio.Instance instance)
           
 
Method Summary
 java.lang.Object[] addDescToItems(java.lang.String sessionKey, java.lang.Object[] itemIds, java.lang.String description)
          "This method allows to add some additional description to list of items.
 java.lang.Long checkItemIdByFutureItemId(java.lang.String webapiKey, java.lang.Long futureItemId)
          "This method allows to get current item's identifier for auction which was listed as future item.
 java.lang.Long checkItemIdByFutureItemId(java.lang.String webapiKey, java.lang.Long countryId, java.lang.Long futureItemId)
          "This method allows to get current item's identifier for auction which was listed as future item.
 java.util.LinkedList getItemsInfo(java.lang.String sessionKey, java.lang.Object[] itemIds, java.lang.Boolean getItemsDescription, java.lang.Boolean getItemsImageUrl)
          Wczytuje informacje o przedmiotach (maksymalnie 25 przedmiotów).
 java.lang.Long getSystemTime(java.lang.String webapiKey)
          Zwraca czas systemowy Allegro.
 java.lang.Long getTimeDiff(java.lang.String webapiKey)
          Zwraca różnicę czasu systemowego Allegro i czasu lokalnego.
 java.lang.Long getUserId(java.lang.Long countryId, java.lang.String userLogin, java.lang.String userEmail)
          Zwraca ID użytkownika Allegro.
 java.lang.Long getUserId(java.lang.String userLogin, java.lang.String userEmail)
          Zwraca ID użytkownika Allegro.
 java.lang.Object[] getUserItems(java.lang.Long userId, java.lang.String webapiKey, java.lang.Long offset)
          Zwraca informacje o przedmiotach użytkownika.
 java.lang.Object[] getUserItems(java.lang.Long userId, java.lang.String webapiKey, java.lang.Long countryId, java.lang.Long offset)
          Zwraca informacje o przedmiotach użytkownika.
 java.lang.String getUserLogin(java.lang.Long userId)
          Zwraca login użytkownika Allegro.
 java.lang.String getUserLogin(java.lang.Long countryId, java.lang.Long userId)
          Zwraca login użytkownika Allegro.
 java.lang.String getVersion()
          Returns the module version
 java.lang.String login(java.lang.String userLogin, java.lang.String userPassword, java.lang.String webapiKey)
          Tworzy sesję w serwisie Allegro.
 java.util.Map showItemInfo(java.lang.String sessionKey, java.lang.Long itemId, java.lang.Boolean getItemDescription, java.lang.Boolean getItemImageUrl)
          Wczytuje informacje o przedmiocie.
 
Methods inherited from class palio.modules.core.Module
getConfigParam, getDescription, getModuleTranslation
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Allegro

public Allegro(palio.Instance instance)
Method Detail

getVersion

public java.lang.String getVersion()
Description copied from class: palio.modules.core.Module
Returns the module version

Specified by:
getVersion in class palio.modules.core.Module

login

public java.lang.String login(java.lang.String userLogin,
                              java.lang.String userPassword,
                              java.lang.String webapiKey)
                       throws ServiceException,
                              java.rmi.RemoteException
Tworzy sesję w serwisie Allegro. Klucz sesji jest niezbędny w większości pozostałych wywołaniach WebAPI. Klucz WebAPI jest generowany przez pracownika Allegro na żądanie użytkownika i definiuje zakres dostępnych funkcji (część funkcji WebAPI jest płatna). Sesja jest nawiązywana na 3 godziny. Użytkownik może mieć maksymalnie 5 aktywnych sesji. Interfejs WebAPI nie udostępnia funkcji kończącej sesję!

Parameters:
userLogin - login użytkownika Allegro
userPassword - hasło użytkownika
webapiKey - klucz WebAPI
Returns:
klucz do utworzonej sesji
Throws:
ServiceException
java.rmi.RemoteException

getSystemTime

public java.lang.Long getSystemTime(java.lang.String webapiKey)
                             throws ServiceException,
                                    java.rmi.RemoteException
Zwraca czas systemowy Allegro. Wywołanie nie wymaga podania klucza sesji a jedynie klucz WebAPI. Allegro zwraca czas z dokładnością do sekund.

Parameters:
webapiKey - klucz WebAPI
Returns:
czas w milisekundach
Throws:
ServiceException
java.rmi.RemoteException

getTimeDiff

public java.lang.Long getTimeDiff(java.lang.String webapiKey)
                           throws ServiceException,
                                  java.rmi.RemoteException
Zwraca różnicę czasu systemowego Allegro i czasu lokalnego. Allegro zwraca czas z dokładnością do sekund.

Parameters:
webapiKey - klucz WebAPI
Returns:
różnica czasu w milisekundach
Throws:
ServiceException
java.rmi.RemoteException

getUserId

public java.lang.Long getUserId(java.lang.String userLogin,
                                java.lang.String userEmail)
                         throws ServiceException,
                                java.rmi.RemoteException
Zwraca ID użytkownika Allegro. Należy podać login użytkownika LUB adres email (podanie obu danych skutkuje sprawdzeniem jedynie adresu email).

Parameters:
userLogin - login użytkownika
userEmail - email użytkownika
Returns:
ID użytkownika
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doGetUserID

getUserId

public java.lang.Long getUserId(java.lang.Long countryId,
                                java.lang.String userLogin,
                                java.lang.String userEmail)
                         throws ServiceException,
                                java.rmi.RemoteException
Zwraca ID użytkownika Allegro. Należy podać login użytkownika LUB adres email (podanie obu danych skutkuje sprawdzeniem jedynie adresu email).

Parameters:
countryId - ID kraju
userLogin - login użytkownika
userEmail - email użytkownika
Returns:
ID użytkownika
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doGetUserID

getUserLogin

public java.lang.String getUserLogin(java.lang.Long userId)
                              throws ServiceException,
                                     java.rmi.RemoteException
Zwraca login użytkownika Allegro.

Parameters:
userId - ID użytkownika
Returns:
login użytkownika
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doGetUserLogin

getUserLogin

public java.lang.String getUserLogin(java.lang.Long countryId,
                                     java.lang.Long userId)
                              throws ServiceException,
                                     java.rmi.RemoteException
Zwraca login użytkownika Allegro.

Parameters:
countryId - ID kraju
userId - ID użytkownika
Returns:
login użytkownika
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doGetUserLogin

getItemsInfo

public java.util.LinkedList getItemsInfo(java.lang.String sessionKey,
                                         java.lang.Object[] itemIds,
                                         java.lang.Boolean getItemsDescription,
                                         java.lang.Boolean getItemsImageUrl)
                                  throws ServiceException,
                                         java.rmi.RemoteException
Wczytuje informacje o przedmiotach (maksymalnie 25 przedmiotów). Każdy przedmiot jest reprezentowany przez mapę: .

Parameters:
sessionKey - klucz sesji
itemIds - identyfikatory przedmiotów
getItemsDescription - czy wczytywać opisy przedmiotów
getItemsImageUrl - czy pobierać URLe do obrazków
Returns:
lista wczytanych przedmiotów - nie zawiera przedmiotów nieodnalezionych, oraz skasowanych przez pracownika allegro
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doGetItemsInfo

showItemInfo

public java.util.Map showItemInfo(java.lang.String sessionKey,
                                  java.lang.Long itemId,
                                  java.lang.Boolean getItemDescription,
                                  java.lang.Boolean getItemImageUrl)
                           throws ServiceException,
                                  java.rmi.RemoteException
Wczytuje informacje o przedmiocie. Przedmiot jest reprezentowany przez mapę:
  • bid_count - Long ilość ofert
  • buy_now_active - Boolean czy jest opcja Kup Teraz
  • buy_now_price - BigDecimal cena w opcji Kup Teraz
  • item_country - Long ID kraju
  • description - String opis
  • ending_time - Date koniec aukcji
  • foto_count - Long ilość fotek
  • high_bidder - Long ID użytkownika, który złożył najwyższą ofertę
  • high_bidder_login - String login użytkownika, który złożył najwyższą ofertę
  • id - Long ID przedmiotu
  • location - String lokalizacja
  • name - String nazwa przedmiotu
  • options - Long opcje dodatkowe
  • price - BigDecimal aktualna cena
  • quantity - Long ilość
  • reserve_price - BigDecimal cena minimalna
  • seller - Long ID sprzedawcy
  • seller_login - String login sprzedawcy
  • seller_rating - Long ilość punktów sprzedającego
  • starting_price - BigDecimal cena początkowa
  • starting_time - Date data rozpoczęcia aukcji
  • state - Long status przedmiotu
.

Parameters:
sessionKey - klucz sesji
itemId - identyfikator przedmiotu
getItemDescription - czy wczytać opis przedmiotu
getItemImageUrl - czy pobrać URLe do obrazków
Returns:
mapa z danymi przedmiotu
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doShowItemInfo

getUserItems

public java.lang.Object[] getUserItems(java.lang.Long userId,
                                       java.lang.String webapiKey,
                                       java.lang.Long offset)
                                throws ServiceException,
                                       java.rmi.RemoteException
Zwraca informacje o przedmiotach użytkownika. Każdy przedmiot to mapa:
  • bid_count - Long ilość ofert
  • buy_now_price - BigDecimal cena w opcji Kup Teraz
  • item_country - Long ID kraju
  • foto_count - Long ilość fotek
  • id - Long ID przedmiotu
  • is_bold_title - Boolean czy tytuł jest pogrubiony
  • is_buy_now - Boolean czy jest opcja Kup Teraz
  • is_escrow - Boolean czy jest opcja Escrow
  • is_listing_thumb - Boolean
  • is_reserved_price - Boolean czy jest ustawiona cena minimalna
  • name - String nazwa przedmiotu
  • price - BigDecimal aktualna cena
  • starting_time - Date data rozpoczęcia aukcji
  • time_left - Long czas do końca aukcji w sekundach lub <0 jeżeli aukcja się zakończyła
.

Parameters:
userId - ID użytkownika
webapiKey - klucz WebAPI
offset - kolejna paczka wyników (0, 1, 2...)
Returns:
tablica [lista przedmiotów (paczka max 25 przedmiotów), całkowita ilość przedmiotów]
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doGetUserItems

getUserItems

public java.lang.Object[] getUserItems(java.lang.Long userId,
                                       java.lang.String webapiKey,
                                       java.lang.Long countryId,
                                       java.lang.Long offset)
                                throws ServiceException,
                                       java.rmi.RemoteException
Zwraca informacje o przedmiotach użytkownika. Każdy przedmiot to mapa:
  • bid_count - Long ilość ofert
  • buy_now_price - BigDecimal cena w opcji Kup Teraz
  • item_country - Long ID kraju
  • foto_count - Long ilość fotek
  • id - Long ID przedmiotu
  • is_bold_title - Boolean czy tytuł jest pogrubiony
  • is_buy_now - Boolean czy jest opcja Kup Teraz
  • is_escrow - Boolean czy jest opcja Escrow
  • is_listing_thumb - Boolean
  • is_reserved_price - Boolean czy jest ustawiona cena minimalna
  • name - String nazwa przedmiotu
  • price - BigDecimal aktualna cena
  • starting_time - Date data rozpoczęcia aukcji
  • time_left - Long czas do końca aukcji w sekundach lub <0 jeżeli aukcja się zakończyła
.

Parameters:
userId - ID użytkownika
webapiKey - klucz WebAPI (Twój)
countryId - ID kraju
offset - kolejna paczka wyników (0, 1, 2...)
Returns:
tablica [lista przedmiotów (paczka max 25 przedmiotów), całkowita ilość przedmiotów]
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doGetUserItems

addDescToItems

public java.lang.Object[] addDescToItems(java.lang.String sessionKey,
                                         java.lang.Object[] itemIds,
                                         java.lang.String description)
                                  throws ServiceException,
                                         java.rmi.RemoteException
"This method allows to add some additional description to list of items. Maximum number of elements of itemIds array is 25 items."

Returns:
trzyelementowa tablica: [Object[] alteredItemIds, Object[] tooLongDescItemIds, Object[] notFoundItemIds]
Throws:
ServiceException
java.rmi.RemoteException
See Also:
doAddDescToItems

checkItemIdByFutureItemId

public java.lang.Long checkItemIdByFutureItemId(java.lang.String webapiKey,
                                                java.lang.Long futureItemId)
                                         throws ServiceException,
                                                java.rmi.RemoteException
"This method allows to get current item's identifier for auction which was listed as future item. This method return current item's identifer or 0 if future auction is not active yet."

Throws:
ServiceException
java.rmi.RemoteException
See Also:

checkItemIdByFutureItemId

public java.lang.Long checkItemIdByFutureItemId(java.lang.String webapiKey,
                                                java.lang.Long countryId,
                                                java.lang.Long futureItemId)
                                         throws ServiceException,
                                                java.rmi.RemoteException
"This method allows to get current item's identifier for auction which was listed as future item. This method return current item's identifer or 0 if future auction is not active yet."

Throws:
ServiceException
java.rmi.RemoteException
See Also: