|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpalio.modules.core.Module
palio.modules.Ads
public final class Ads
Moduł do obsługi serwera z reklamami. Możliwe statusy występujące w tym module: [A]ctive, [B]locked, [D]eleted. Obsługiwane typy rotatora reklam: [S]impleRotator (wyświetla reklamy po kolei), [D]rawRotator (losowanie reklam z uwzględnieniem wag).
Moduł wymaga dodatkowych tabelek w bazie danych. Dodatkowo w konfiguracji można podać parametr "connector".
Moduł trzeba dodać w konfiguracji instancji jPalio.
Field Summary |
---|
Fields inherited from interface palio.Constants |
---|
DECIMAL_ZERO, INTEGER_ONE, LONG_MINUS_ONE, LONG_ONE, LONG_THREE, LONG_TWO, LONG_ZERO, STRING_EMPTY |
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 | |
---|---|
Ads(Instance instance,
java.util.Properties parameters)
|
Method Summary | |
---|---|
void |
activateAd(java.lang.Long adID)
Aktywuje zablokowaną reklamę przez ustawienie statusu [A]ctive. |
void |
activateClient(java.lang.Long clientID)
Aktywuje zablokowanego klienta przez ustawienie statusu [A]ctive. |
void |
activateRotator(java.lang.Long rotatorID)
Aktywuje zablokowany rotator przez ustawienie statusu [A]ctive. |
java.util.LinkedList |
adHistory(java.lang.Long adID,
java.util.Date dateFrom,
java.util.Date dateTo)
Zwraca historię odsłon i kliknięć na daną reklamę. |
java.lang.Object[] |
adStats(java.lang.Long adID)
Zwraca proste statystyki odsłon i kliknięć na daną reklamę. |
java.lang.Object[] |
adStats(java.lang.Long adID,
java.util.Date dateFrom,
java.util.Date dateTo)
Zwraca proste statystyki odsłon i kliknięć na daną reklamę. |
java.lang.Object[] |
adURL(java.lang.Long rotatorID,
java.lang.Object[] adFields)
Zwraca komplet linków do danej reklamy. |
void |
blockAd(java.lang.Long adID)
Blokuje aktywną reklamę przez ustawienie statusu [B]locked. |
void |
blockClient(java.lang.Long clientID)
Blokuje aktywnego klienta przez ustawienie statusu [B]locked. |
void |
blockRotator(java.lang.Long rotatorID)
Blokuje aktywny rotator przez ustawienie statusu [B]locked. |
java.util.LinkedList |
clientStats(java.lang.Long clientID)
Zwraca proste statystyki odsłon i kliknięć na reklamy danego klienta. |
java.util.LinkedList |
clientStats(java.lang.Long clientID,
java.util.Date dateFrom,
java.util.Date dateTo)
Zwraca proste statystyki odsłon i kliknięć na reklamy danego klienta. |
java.lang.Long |
createAd(java.lang.Long rotatorID,
java.lang.Long clientID,
java.lang.Object[] fileBanner,
java.lang.Long weight,
java.util.Date expired,
java.lang.Long maxViewCount,
java.lang.String targetLink,
java.lang.String caption,
java.lang.String description)
Tworzy nową reklamę. |
java.lang.Long |
createAd(java.lang.Long rotatorID,
java.lang.Long clientID,
java.lang.String banner,
java.lang.Long weight,
java.util.Date expired,
java.lang.Long maxViewCount,
java.lang.String targetLink,
java.lang.String caption,
java.lang.String description)
Tworzy nową reklamę. |
java.lang.Long |
createClient(java.lang.String name,
java.lang.String address,
java.lang.String city,
java.lang.String country,
java.lang.String phone,
java.lang.String email,
java.lang.String identifier,
java.lang.String description)
Tworzy nowego klienta (właściciela reklam). |
java.lang.Long |
createRotator(java.lang.String name,
java.lang.String type,
java.lang.String description)
Tworzy nowy rotator reklam (grupa reklam z określoną polityką wyświetlania). |
void |
deleteAd(java.lang.Long adID)
Kasuje reklamę (ustawia status [D]eleted). |
void |
deleteClient(java.lang.Long clientID)
Kasuje klienta wraz ze wszystkimi jego reklamami (ustawia status [D]eleted). |
void |
deleteRotator(java.lang.Long rotatorID)
Kasuje rotator wraz ze wszystkimi podpiętymi do niego reklamami (ustawia status [D]eleted). |
java.lang.Object[] |
getAd(java.lang.Long adID)
Zwraca dane reklamy w postaci tablicy z wartościami pól: [identyfikator, status, nazwa rotatora, nazwa klienta, data utworzenia, data ostatniej odsłony, waga, ilość wyświetleń, całkowita ilość wyświetleń, maksymalna ilość wyświetleń, data ostatniego kliknięcia, liczba kliknięć, data zablokowania, data wygaśnięcia, adres docelowy, podpis, opis]. |
java.util.LinkedList |
getAds()
Zwraca listę wszystkich reklam. |
java.util.LinkedList |
getAds(java.lang.Long rotatorID,
java.lang.Long clientID)
Zwraca listę reklam przypisanych do podanego rotatora i/lub klienta. |
java.lang.Object[] |
getClient(java.lang.Long clientID)
Zwraca dane klienta w postaci tablicy z wartościami pól: [identyfikator, status, nazwa, data utworzenia, data zablokowania, adres, miasto, kraj, numer telefonu, adres email, dodatkowy identyfikator, opis]. |
java.lang.Object[] |
getClient(java.lang.String clientName)
Zwraca dane klienta w postaci tablicy z wartościami pól: [identyfikator, status, nazwa, data utworzenia, data zablokowania, adres, miasto, kraj, numer telefonu, adres email, dodatkowy identyfikator, opis]. |
java.util.LinkedList |
getClients()
Zwraca listę wszystkich klientów. |
java.lang.Object[] |
getRotator(java.lang.Long rotatorID)
Zwraca dane rotatora w postaci tablicy z wartościami pól: [identyfikator, status, typ, nazwa, data utworzenia, data zablokowania, opis]. |
java.lang.Object[] |
getRotator(java.lang.String rotatorName)
Zwraca dane rotatora w postaci tablicy z wartościami pól: [identyfikator, status, typ, nazwa, data utworzenia, data zablokowania, opis]. |
java.util.LinkedList |
getRotators()
Zwraca listę wszystkich rotatorów. |
java.lang.String |
getVersion()
Returns the module version |
java.util.LinkedList |
rotatorStats(java.lang.Long rotatorID)
Zwraca proste statystyki odsłon i kliknięć na reklamy w danym rotatorze. |
java.util.LinkedList |
rotatorStats(java.lang.Long rotatorID,
java.util.Date dateFrom,
java.util.Date dateTo)
Zwraca proste statystyki odsłon i kliknięć na reklamy z danego rotatora. |
java.lang.Object[] |
rotatorURL(java.lang.Long rotatorID)
Zwraca komplet linków (dwuelementowa tablica) do danego rotatora reklam, z którego pierwszy element używamy do wyświetlenia reklamy (atrybut SRC) a drugi do kliknięcia na reklamie (atrybut HREF). |
java.lang.Object[] |
rotatorURL(java.lang.String rotatorName)
Zwraca URL do danego rotatora reklam. |
void |
undeleteAd(java.lang.Long adID)
Przywraca skasowaną reklamę (ustawia status [A]ctive). |
void |
undeleteClient(java.lang.Long clientID)
Przywraca skasowanego klienta (ustawia status [A]ctive). |
void |
undeleteRotator(java.lang.Long rotatorID)
Przywraca skasowany rotator (ustawia status [A]ctive). |
void |
updateAd(java.lang.Long adID,
java.lang.Long rotatorID,
java.lang.Long clientID,
java.lang.Long weight,
java.util.Date expired,
java.lang.Long maxViewCount,
java.lang.String targetLink,
java.lang.String caption,
java.lang.String description)
Aktualizuje dane reklamy. |
void |
updateClient(java.lang.Long clientID,
java.lang.String name,
java.lang.String address,
java.lang.String city,
java.lang.String country,
java.lang.String phone,
java.lang.String email,
java.lang.String identifier,
java.lang.String description)
Aktualizuje dane klienta. |
void |
updateRotator(java.lang.Long rotatorID,
java.lang.String name,
java.lang.String type,
java.lang.String description)
Aktualizuje dane rotatora. |
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 |
---|
public Ads(Instance instance, java.util.Properties parameters) throws palio.PalioException
palio.PalioException
Method Detail |
---|
public java.lang.String getVersion()
Module
getVersion
in class Module
public java.lang.Long createRotator(java.lang.String name, java.lang.String type, java.lang.String description) throws palio.PalioException
name
- nazwa dla rotatoratype
- typ rotatora: "S" lub "D"description
- dodatkowy opis rotatora
palio.PalioException
public java.lang.Object[] getRotator(java.lang.Long rotatorID) throws palio.PalioException
palio.PalioException
public java.lang.Object[] getRotator(java.lang.String rotatorName) throws palio.PalioException
palio.PalioException
public java.util.LinkedList getRotators() throws palio.PalioException
palio.PalioException
public void blockRotator(java.lang.Long rotatorID) throws palio.PalioException
rotatorID
- identyfikator rotatora
palio.PalioException
public void activateRotator(java.lang.Long rotatorID) throws palio.PalioException
rotatorID
- identyfikator rotatora
palio.PalioException
public void updateRotator(java.lang.Long rotatorID, java.lang.String name, java.lang.String type, java.lang.String description) throws palio.PalioException
rotatorID
- identyfikator rotatoraname
- nowa nazwa rotatoratype
- nowy typ rotatora: "S" lub "D"description
- nowy opis rotatora
palio.PalioException
public void deleteRotator(java.lang.Long rotatorID) throws palio.PalioException
palio.PalioException
public void undeleteRotator(java.lang.Long rotatorID) throws palio.PalioException
palio.PalioException
public java.lang.Object[] rotatorURL(java.lang.Long rotatorID) throws palio.PalioException
$=(AdURL, $ads.rotatorURL(1)) <a href='$AdURL[1]'><img src='$AdURL[0]'></a>
palio.PalioException
public java.lang.Object[] rotatorURL(java.lang.String rotatorName) throws palio.PalioException
palio.PalioException
public java.lang.Object[] adURL(java.lang.Long rotatorID, java.lang.Object[] adFields) throws palio.PalioException
$=(AdURL, $ads.adURL(1, [CAPTION])) <a href='$AdURL[1]'><img src='$AdURL[0]' alt='$AdURL[2]'></a>
rotatorID
- identyfikator rotatoraadFields
- dodatkowe pola dotyczące reklamy jakie chcemy wyciągnąć z tabeli AD_ADS
palio.PalioException
- rzucane wyjątki: "no such rotator", "unknown rotator type"public java.lang.Long createClient(java.lang.String name, java.lang.String address, java.lang.String city, java.lang.String country, java.lang.String phone, java.lang.String email, java.lang.String identifier, java.lang.String description) throws palio.PalioException
name
- nazwa klientaaddress
- adres klientacity
- miasto klientacountry
- kraj klientaphone
- numer telefonu klientaemail
- adres email klientaidentifier
- dodatkowy identyfikator klientadescription
- dodatkowy opis klienta
palio.PalioException
public java.lang.Object[] getClient(java.lang.Long clientID) throws palio.PalioException
palio.PalioException
public java.lang.Object[] getClient(java.lang.String clientName) throws palio.PalioException
palio.PalioException
public java.util.LinkedList getClients() throws palio.PalioException
palio.PalioException
public void blockClient(java.lang.Long clientID) throws palio.PalioException
clientID
- identyfikator klienta
palio.PalioException
public void activateClient(java.lang.Long clientID) throws palio.PalioException
clientID
- identyfikator klienta
palio.PalioException
public void updateClient(java.lang.Long clientID, java.lang.String name, java.lang.String address, java.lang.String city, java.lang.String country, java.lang.String phone, java.lang.String email, java.lang.String identifier, java.lang.String description) throws palio.PalioException
clientID
- identyfikator klientaname
- nowa nazwa klientadescription
- nowy opis klienta
palio.PalioException
public void deleteClient(java.lang.Long clientID) throws palio.PalioException
palio.PalioException
public void undeleteClient(java.lang.Long clientID) throws palio.PalioException
palio.PalioException
public java.lang.Long createAd(java.lang.Long rotatorID, java.lang.Long clientID, java.lang.String banner, java.lang.Long weight, java.util.Date expired, java.lang.Long maxViewCount, java.lang.String targetLink, java.lang.String caption, java.lang.String description) throws palio.PalioException, java.io.IOException
rotatorID
- identyfikator rotatoraclientID
- identyfikator klientabanner
- URL (bezwzględny, np: "http://xyz.com/plik.jpg") lub ścieżka do pliku reklamyweight
- waga z jaką będzie losowana reklama (jeżeli należy do rotatora używającego wag)expired
- data wygaśnięcia aktywności reklamy (po tej dacie reklama zostanie zablokowana)maxViewCount
- maksymalna liczba odsłon reklamy (po osiągnięciu ilości odsłon reklama zostanie zablokowana)targetLink
- link do którego prowadzi reklamacaption
- krótki opis, np.: do znacznika ALT w tagu IMGdescription
- dodatkowy opis reklamy
palio.PalioException
java.io.IOException
public java.lang.Long createAd(java.lang.Long rotatorID, java.lang.Long clientID, java.lang.Object[] fileBanner, java.lang.Long weight, java.util.Date expired, java.lang.Long maxViewCount, java.lang.String targetLink, java.lang.String caption, java.lang.String description) throws palio.PalioException
rotatorID
- identyfikator rotatoraclientID
- identyfikator klientafileBanner
- plik reklamy w postaci tablicy Object[] - takiej jaką się otrzymuje z formularza z pola uploadFieldweight
- waga z jaką będzie losowana reklama (jeżeli należy do rotatora używającego wag)expired
- data wygaśnięcia aktywności reklamy (po tej dacie reklama zostanie zablokowana)maxViewCount
- maksymalna liczba odsłon reklamy (po osiągnięciu ilości odsłon reklama zostanie zablokowana)targetLink
- link do którego prowadzi reklamacaption
- krótki opis, np.: do znacznika ALT w tagu IMGdescription
- dodatkowy opis reklamy
palio.PalioException
public java.lang.Object[] getAd(java.lang.Long adID) throws palio.PalioException
palio.PalioException
public java.util.LinkedList getAds() throws palio.PalioException
palio.PalioException
public java.util.LinkedList getAds(java.lang.Long rotatorID, java.lang.Long clientID) throws palio.PalioException
palio.PalioException
public void blockAd(java.lang.Long adID) throws palio.PalioException
adID
- identyfikator reklamy
palio.PalioException
public void activateAd(java.lang.Long adID) throws palio.PalioException
adID
- identyfikator reklamy
palio.PalioException
public void updateAd(java.lang.Long adID, java.lang.Long rotatorID, java.lang.Long clientID, java.lang.Long weight, java.util.Date expired, java.lang.Long maxViewCount, java.lang.String targetLink, java.lang.String caption, java.lang.String description) throws palio.PalioException
rotatorID
- identyfikator rotatoraclientID
- identyfikator klientaweight
- waga z jaką będzie losowana reklama (jeżeli należy do rotatora używającego wag)expired
- data wygaśnięcia aktywności reklamy (po tej dacie reklama zostanie zablokowana)maxViewCount
- maksymalna liczba odsłon reklamy (po osiągnięciu ilości odsłon reklama zostanie zablokowana)targetLink
- link do którego prowadzi reklamacaption
- krótki opis, np.: do znacznika ALT w tagu IMGdescription
- dodatkowy opis reklamy
palio.PalioException
public void deleteAd(java.lang.Long adID) throws palio.PalioException
palio.PalioException
public void undeleteAd(java.lang.Long adID) throws palio.PalioException
palio.PalioException
public java.lang.Object[] adStats(java.lang.Long adID) throws palio.PalioException
adID
- identyfikator reklamy
palio.PalioException
public java.lang.Object[] adStats(java.lang.Long adID, java.util.Date dateFrom, java.util.Date dateTo) throws palio.PalioException
adID
- identyfikator reklamydateFrom
- statystyki od podanej daty (może być null)dateTo
- statystyki do podanej daty (może być null)
palio.PalioException
public java.util.LinkedList clientStats(java.lang.Long clientID) throws palio.PalioException
clientID
- identyfikator klienta
palio.PalioException
public java.util.LinkedList clientStats(java.lang.Long clientID, java.util.Date dateFrom, java.util.Date dateTo) throws palio.PalioException
clientID
- identyfikator klientadateFrom
- statystyki od podanej daty (może być null)dateTo
- statystyki do podanej daty (może być null)
palio.PalioException
public java.util.LinkedList rotatorStats(java.lang.Long rotatorID) throws palio.PalioException
rotatorID
- identyfikator rotatora
palio.PalioException
public java.util.LinkedList rotatorStats(java.lang.Long rotatorID, java.util.Date dateFrom, java.util.Date dateTo) throws palio.PalioException
rotatorID
- identyfikator rotatoradateFrom
- statystyki od podanej daty (może być null)dateTo
- statystyki do podanej daty (może być null)
palio.PalioException
public java.util.LinkedList adHistory(java.lang.Long adID, java.util.Date dateFrom, java.util.Date dateTo) throws palio.PalioException
adID
- identyfikator reklamydateFrom
- historia od podanej daty (może być null)dateTo
- historia do podanej daty (może być null)
palio.PalioException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |