palio.modules
Class Report

java.lang.Object
  palio.modules.core.Module
      palio.modules.Report

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class Report
extends Module

Moduł zawiera zestaw funkcji wspomagających tworzenie raportów.

Moduł należy zadeklarować.

Moduł raportowy wspomaga tworzenie dużych raportów poprzez możliwość gromadzenia generowanych danych w pliku tymczasowym na dysku maszyny, na której uruchomiona jest instancja jPalio generująca raport. Generowane raporty mogą mieć dowolny typ, zarówno tekstowy jak i binarny: txt, csv, html, xls itd.

Raport jest wykonywanym na żądanie obiektem jPalio generującym dowolną treść. Generowana treść jest sukcesywnie dołączana do bufora za pomocą funkcji append. Po wykonaniu obiektu bufor przechowujący treść raportu jest zapisywany do obiektu typu BLOB w tabeli r_orders i ew. od razu kompresowany. Treść skompresowana jest zapisywana do osobnego pola BLOB niż treść nieskompresowana. Wewnątrz obiektu generującego może być zapisany dowolny algorytm: zapytanie sql, kilka zapytań, kombinacja zapytań i przetwarzania w jpalio (świetnie się sprawdza przy robieniu raportów zliczeniowych) itd.

Do modułu dołączony jest gotowy interfejs html tworzony za pomocą $report.createOrReplaceHtmlInterface(). Za jego pomocą można zamówić raport, który zostanie wykonany w tle przez zadanie o godzinie określonej we właściwościach raportu. Zadanie trzeba napisać samodzielnie na podstawie przykładu zawartego w interfejsie. Dodanie raportu polega na dodaniu kilku obiektów wspópracujących ze wspomnianym interfejsem. Szablony obiektów są zawarte w interfejsie. Jeden z tych obiektów służy do generowania właściwego raportu.

Obiekt generujący raport jest przypisany do typu raportu określonego w tabeli r_types. Obiekt taki powinien być sparametryzowany. W tabeli r_types istnieją pola param_form_init_object, param_form_display_object, param_form_check_object, param_form_save_object w których system przyjmowania zleceń na raporty przechowuje id obiektów inicjalizujących, wyświetlających, sprawdzających i zapisujących formularz, pozwalający określić parametry raportu. Obiekt zapisujący wywołuje funkcję addReport, do której przekazywana jest tabela nazw parametrów, zapamiętywanych jako parametry raportu. Parametry te są zapisywane przez addReport w nowym zleceniu na raport danego typu w tabeli r_orders. Przed wykonywaniem obiektu raportu parametry są odtwarzane przez funkcję executeReport w kontekście, w którym raport jest wykonywany (ustawiane jako zwykłe parametry jPaliowe). Tabela r_types zawiera także parametry zaczynające się prefiksem default_ określające domyślne warunki wykonywania raportu danego typu. Warunki te są przepisywane do tabeli r_orders wraz z tworzeniem nowego zlecenia na raport. Funkcja wykonująca raport bierze pod uwagę warunki wykonania z r_orders. Nie jest zalecane modyfikowanie warunków wykonania w tabeli r_orders. Czas wykonania może być inny niż czas dodania zlecenia na raport, np. można umożliwić ciągłe przyjmowanie zleceń na raporty, ale wykonywać je lub kompresować za pomocą zadania w czasie mniejszego obciążenia.

Każde zlecenie na raport w r_orders posiada pole stanu (z wartością ze słownika w tabeli r_states) i dodatkowe flagi określające status zlecenia. System zarządzający raportami (interfejs html modułu) na podstawie tych flag wyświetla listę dostępnych raportów i umożliwia użytkownikom pobranie wygenerowanych raportów - w celu generacji linków w innych miejscach aplikacji można użyć funkcji reportURL i compressedReportURL.

Wszystkie funkcje operujące na raportach (wykonujące, kompresujące i obcinające) są zabezpieczone przed jednoczesnym operowaniem na tym samym raporcie, można więc uruchomić jednocześnie kilka zadań wykonujących raporty (w ramach tej samej instancji jPalio) bez obawy wykonania tego samego zlecenia kilkukrotnie.

Położenie tabel modułu raportowego jest określone za pomocą konektora o nazwie zdefiniowanej w parametrze connector_name deklaracji modułu w pliku konfiguracyjnym instancji. Jeśli żaden konektor nie jest określony, moduł odwołuje się do tabel przez standardowy konektor data.

Dzięki możliwości umieszczenia danych raportów w miejscu określonych konektorem oraz dzięki możliwości przypisania typów raportów do określonych kategorii typów (tabela r_categories), można stworzyć system raportowy dla wielu usług (instancji jpalio), umieszczony na jednej maszynie, na której każda usługa zapisywałaby własne raporty (własne w sensie przynależności do kategorii przypisanej usłudze), udostępniane nastepnie w jednolity sposób użytkownikom. Wykonanie raportów z różnych instancji może być bezkonfliktowe dzięki wykorzystaniu funkcji executeFirstReport wykonującej pierwszy w kolejce raport należący danej kategorii.

Sposób użycia:

1. Dla jPALIO w wersji niższej niż 7.4 należy utworzyć tabele dla raportów w wybranym schemacie bazy danych za pomocą skryptów zawartych w dalszej części opisu. Dla jPALIO 7.4 i nowszych tabele zostaną utworzone automatycznie.

   Po utworzeniu tabel należy wykonać następujący zestaw insertów:

    insert into r_order_states ( id, name ) values ('O', 'Zamówiony'); 
    insert into r_order_states ( id, name ) values ('C', 'Anulowany'); 
    insert into r_order_states ( id, name ) values ('G', 'W trakcie generacji'); 
    insert into r_order_states ( id, name ) values ('R', 'Wykonany'); 
    insert into r_order_states ( id, name ) values ('L', 'Zablokowany'); 
    
    ---------------------------------------------------------------------------------------------------------------
    
    insert into r_type_categories ( id, name ) values ('default', 'Grupa domyślna'); 
    
    ---------------------------------------------------------------------------------------------------------------
    
    insert into r_types ( id, active, default_file_name_timestamp, 
      can_immediate_execute, defult_generation_priority, param_form_init_object,
      param_form_display_object, param_form_check_object, param_form_save_object,
      generation_object, category_id, name,
      default_file_name, default_mime_type, description, 
      default_compressed, default_generation_method ) 
    values ( 
      1, 'T', 'F',
      'T', 0, 91030,
      91031, 91032, 91033,
      91034, 'default', 'Raport testowy obiektów referencyjnych',
      'test_rep', 'text/html', NULL,
      'F', 'MEMORY');
    

2. W konfiguracji instancji należy dodać wpis deklarujący moduł a w nim wskazać nazwę konektora do schematu zawierającego utworzone tabele (przykład poniżej zakłada, że tabele raportowe są w tym samym schemacie co tabele jPalio). Jeżeli tabele modułu report są w bazie, na którą wskazuje konektor data, ten punkt mozna pominąć.

      <module name="report">
        <connector_name>palio</connector_name>
      </module>
    

3. W dowolnym obiekcie wykonać funkcję $report.createOrReplaceHtmlInterface(), co spowoduje utworzenie interfejsu do zarządzania, zlecania i pobierania raportów (zostanie utworzony zestaw obiektów i stron jPalio).

4. W portalu dodać linki do zarządzania raportami. Przykładowy zestaw linków poniżej i w obiekcie report_module.examples.links (91036) interfejsu do zarządzania.

    <a class="mainpage_menu_link" href="#" onclick="window.open('$url(report_module.types,null,
      $util.urlEncode("&interfaceMode=admin&reportModuleStyleSheet=&allowedCategories=&allowedTypes=&mainTitle=raporty dla portalu
    xyz"))')" >
      Zarządzanie typami raportów</a><br>
    <a class="mainpage_menu_link" href="#" onclick="window.open('$url(report_module.orders,null,
      $util.urlEncode("&interfaceMode=order&reportModuleStyleSheet=&allowedCategories=&allowedTypes=&mainTitle=raporty dla portalu
    xyz"))')" >
      Zlecanie raportów</a><br>
    <a class="mainpage_menu_link" href="#" onclick="window.open('$url(report_module.by_types,null,
      $util.urlEncode("&interfaceMode=get&reportModuleStyleSheet=&allowedCategories=&allowedTypes=&mainTitle=raporty dla portalu
    xyz"))')" >
      Pobieranie raportów</a><br>
    

   W linku można przekazać dodatkowe parametry:

   • interfaceMode - parametr obowiązkowy, oznaczający tryb interfejsu: "admin" - zarządzanie kategoriami i typami, zlecanie i pobieranie raportów, "order" - zlecanie i pobieranie raportów, "get" - pobieranie raportów
   • reportModuleStyleSheet - id lub kod obiektu, który zastąpi standardowy arkusz styli CSS interfejsu
   • allowedCategories - lista id kategorii, rozdzielonych przecinkami, które będą widoczne w sekcjach do zlecania i pobierania raportów, np: " 'default','katA','katB' "
   • allowedTypes - lista id typów, rozdzielonych przecinkami, które będą widoczne w sekcjach do zlecania i pobierania raportów, np: "1,2,7"
   • mainTitle - tytuł wyświetlany na górze każdej strony interfejsu
   
   

5. Napisać obiekty generujące raport(y) oraz umożliwiające jego zlecanie, wzorując się na obiektach z katalogu "02 Obiekty referencyjne" interfejsu do zarządzania. Jeśli parametrem raportu jest jedynie zakres czasowy, można ograniczyć się do użycia przykładowych obiektów i napisać tylko obiekt generujący raport.

   Po utworzeniu odpowiednich obiektów należy dodać nowy typ raportu przypisując do niego te obiekty. Aby utworzone obiekty były widoczne w interfejsie do zarządzania raportami ich nazwy muszą zaczynać się ciągiem "Rep obj ".

   Obiekty inicjalizacji i sprawdzania nie są wymagane, interfejs zakłada wtedy, że dane w formularzu zamówienia są poprawne i zawsze po submicie formularza zlecenia wywołuje obiekt zapisu zlecenia.

6. Utworzyć zadanie (lub kilka), które będzie wykonywało zlecone raporty. Przykładowy obiekt zadania realizujący taką funkcjonalność jest zawarty w report_module.examples.scheduler_execution (91035).
   Osoby z uprawnieniami "order" mogą wykonać ręcznie te raporty, dla których przy określaniu typu zaznaczono flagę wykonania ręcznego. Uprawnienia "admin" pozwalają wykonać dowolny raport. Ręczne wykonanie raportów jest możliwe na stronie "raporty oczekujące".

Przepływ sterowania pomiędzy obiektami służącymi do zlecania raportów.

\	/
obiekt inicjalizacji formularza zlecenia (param_form_init_object)
\	/
obiekt wyświetlający formularz zlecenia (param_form_display_object)		/
		\
	reportOrderFormError = null
\	/
obiekt sprawdzający formularz zlecenia (param_form_check_object)		reportOrderFormError != null
	reportOrderFormError == null
\	/
obiekt zapisujący formularz zlecenia (param_form_save_object)
\	/
/	\

Moduł wykorzystuje tabele o następującej strukturze:

 create table R_ORDER_STATES (
 ID char(1) not null constraints ROrdSta_Id_PK primary key using index tablespace &2,
 Name varchar2(100) not null ) tablespace &1
 
 create table R_ORDERS (
 ID number(12) not null constraints ROrd_Id_PK primary key using index tablespace &2,
 STATE char(1) not null,
 Generation_correctness char(1) not null,
 Compressed_available char(1) not null,
 Generation_file_name_timestamp char(1),
 Generate_compressed char(1),
 Creation_date date not null,
 Generation_start date,
 Generation_end date,
 Generation_progress_timestamp date,
 TYPE_ID number(6) not null,
 Creation_user_id number(6) not null,
 Generation_priority number(12),
 File_size number(30),
 Compressed_file_size number(30),
 Report_params varchar2(4000),
 Report_description varchar2(4000),
 Generation_method varchar2(20),
 Generation_progress varchar2(100),
 Generation_comment varchar2(4000),
 File_name varchar2(250),
 Mime_type varchar2(50),
 Compressed_file_name varchar2(250),
 Compressed_mime_type varchar2(50),
 Content blob,
 Compressed_content blob ) tablespace &1
 
 create table R_TYPE_CATEGORIES (
 Id varchar2(20) not null constraints RTypCat_Id_PK primary key using index tablespace &2,
 Name varchar2(100) not null ) tablespace &1
 
 create table R_TYPES (
 ID number(6) not null constraints RTyp_Id_PK primary key using index tablespace &2,
 Active char(1) not null,
 Default_file_name_timestamp char(1) not null,
 Default_compressed char(1) not null,
 Can_immediate_execute char(1) not null,
 Defult_generation_priority number(12) not null,
 Param_form_init_object number(6),
 Param_form_display_object number(6),
 Param_form_check_object number(6),
 Param_form_save_object number(6),
 Generation_object number(6),
 CATEGORY_ID varchar2(20) not null,
 Name varchar2(200) not null,
 Default_file_name varchar2(200) not null,
 Default_mime_type varchar2(50) not null,
 Default_generation_method varchar2(20) not null,
 Description varchar2(4000) ) tablespace &1
 
 alter table R_ORDERS add (constraint ROrd_TypId_FK foreign key(TYPE_ID) references R_TYPES(ID));
 alter table R_ORDERS add (constraint ROrd_Sta_FK foreign key(STATE) references R_ORDER_STATES(ID));
 alter table R_TYPES add (constraint RTyp_CatId_FK foreign key(CATEGORY_ID) references R_TYPE_CATEGORIES(Id));
 
 create index ROrd_TypId on R_ORDERS(TYPE_ID) tablespace &2
 create index ROrd_Sta on R_ORDERS(STATE) tablespace &2
 create index RTyp_CatId on R_TYPES(CATEGORY_ID) tablespace &2
 
 create sequence R_ORDERS_S start with 1;
 create sequence R_TYPE_CATEGORIES_S start with 1;
 create sequence R_ORDER_STATES_S start with 1;
 create sequence R_TYPES_S start with 1;
 

Znaczenie pól tabel:

tabela r_type_categories (kategorie typów raportów):

• id - id tekstowe kategorii typów raportów
• name - nazwa kategorii typów raportów

tabela r_types (typy raportów):

• id - id numeryczne typu raportu
• category_id - id tekstowe kategorii, do której należy dany typ raportów
• name - nazwa typu
• active - T/F, czy typ jest aktywny (czy można dodać zlecenie na raport danego typu)
• description - opis typu
• default_file_name - domyślna nazwa pliku dla raportów danego typu
• default_file_name_timestamp - T/F, czy do domyślnej nazwy pliku dodawać czas generacji raportu (format YYYY_MM_DD_HH24_MI_SS)
• default_mime_type - domyślny mime_type dla raportów danego typu
• defult_generation_priority - domyślny priorytet generacji raportów danego typu, raporty o większej wartości liczbowej priorytetu wykonywane są jako pierwsze
• default_generation_method - MEMORY/FILE - sposób wykonania raportu - czy bufor treści raportu jest trzymany w pamięci, czy na dysku maszyny, na której jest uruchomiona instancja jpalio wykonująca raport
• default_compressed - T/F, czy raport od razu po wykonaniu powinien zostać skompresowany (jeśli T, to treść nieskompresowana także jest zapisywana)
• param_form_init_object - informacja dla systemu zarządzania raportami, id obiektu inicjalizującego formularz, w którym ustalane są parametry dodawanego raportu
• param_form_display_object - informacja dla systemu zarządzania raportami, id obiektu wyświetlającego formularz, w którym ustalane są parametry dodawanego raportu
• param_form_check_object - informacja dla systemu zarządzania raportami, id obiektu sprawdzającego formularz, w którym ustalane są parametry dodawanego raportu
• param_form_save_object - informacja dla systemu zarządzania raportami, id obiektu zapisującego formularz, w którym ustalane są parametry dodawanego raportu
• generation_object - id obiektu generującego raport
• can_immediate_execute - T/F, informacja dla systemu zarządzania raportami - czy można pozwolić wykonać użytkownikowi raport na żądanie, poza kolejką i w innym czasie niż wykonywane są pozostałe raporty

tabela r_order_states (słownik stanów zleceń na raport):

• id - id tekstowe stanu (jednoliterowe)
• name - nazwa stanu

tabela r_orders:

• id - id numeryczne zlecenia na raport
• type_id - id typu raportu
• state - stan zlecenia na raport - id ze słownika r_order_states
• report_params - parametry dla obiektu wykonującego raport w formacie param1_name#param1_value#param2_name#param2_value#....
• report_description - opis zlecenia na raport
• creation_date - data utworzenia zlecenia na raport
• creation_user_id - id użytkownika tworzącego zlecenie na raport, jeśli null wstawiana jest wartość -1
• generation_priority - patrz r_types.defult_generation_priority, wartość dla danego zlecenia na raport
• generation_file_name_timestamp - patrz r_types.default_file_name_timestamp, wartość dla danego zlecenia na raport
• generation_method - patrz r_types.default_generation_method, wartość dla danego zlecenia na raport
• generate_compressed - patrz r_types.default_compressed, wartość dla danego zlecenia na raport
• generation_start - data rozpoczęcia generacji
• generation_end - data zakończenia generacji
• generation_progress - postęp generacji raportu - obiekt wykonujący raport może zapisać tu wartość funkcjią setProgressInfo()
• generation_progress_timestamp - czas, kiedy nastąpił ostatni zapis postępu generacji w polu generation_progress
• generation_correctness - T/F, określa, czy raport został wygenerowany poprawnie (czy podczas generacji nie było żadnego wyjątku)
• generation_comment - jeśli podczas generacji wystąpił wyjątek, w tym polu zapisywany jest stack trace ostatniego wyjątku
• file_size - rozmiar treści raportu
• file_name - nazwa raportu
• mime_type - mime type raportu
• content - treść raportu
• compressed_available - T/F, czy skompresowana treść raportu jest dostępna
• compressed_file_size - rozmiar skompresowanej treści raportu
• compressed_file_name - nazwa pliku ze skompresowanym raportem
• compressed_mime_type - mime type pliku ze skompresowanym raportem
• compressed_content - skompresowany raport

Version:

1.1.1

Author:

Arkadiusz Chrustowski

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

Report(Instance instance, java.util.Properties properties)
Konstruktor.

Method Summary

void	addCategory(java.lang.String categoryId) Tworzy nową kategorię raportów o podanym id i nazwie takiej samej jak id.
void	addCategory(java.lang.String categoryId, java.lang.String categoryName) Tworzy nową kategorię raportów o podanym id i nazwie.
java.lang.Long	addReport(java.lang.Long typeId, java.lang.Object[] paramNames, java.lang.String description) Dodaje zlecenie na raport z określonymi parametrami raportu oraz opisem.
java.lang.Long	addReport(java.lang.Long typeId, java.lang.Object[] paramNames, java.lang.String description, java.lang.Long generationPriority, java.lang.String fileName) Dodaje zlecenie na raport z określonymi parametrami raportu, opisem, priorytetem generacji oraz nazwą pliku wynikowego.
java.lang.Long	addReport(java.lang.Long typeId, java.lang.Object[] paramNames, java.lang.String description, java.lang.Long generationPriority, java.lang.String fileName, java.lang.Boolean addTimestampToFileName, java.lang.String mimeType, java.lang.String generationMethod, java.lang.Boolean compressAfterGeneration) Dodaje zlecenie na raport z określonymi parametrami raportu, opisem, priorytetem generacji oraz nazwą i mime type pliku wynikowego.
java.lang.Long	addType(java.lang.String typeName, java.lang.String categoryId) Tworzy nowy typ raportów z podanymi parametrami.
java.lang.Long	addType(java.lang.String typeName, java.lang.String categoryId, java.lang.String defaultFileName, java.lang.String defaultMimeType) Tworzy nowy typ raportów z podanymi parametrami.
java.lang.Long	addType(java.lang.String typeName, java.lang.String categoryId, java.lang.String defaultFileName, java.lang.String defaultMimeType, java.lang.Long defaultGenerationPriority) Tworzy nowy typ raportów z podanymi parametrami.
java.lang.Long	addType(java.lang.String typeName, java.lang.String categoryId, java.lang.String defaultFileName, java.lang.String defaultMimeType, java.lang.Long defaultGenerationPriority, java.lang.Boolean canImmediateExecute, java.lang.Boolean isActive, java.lang.Boolean isFileNameTimestampAdded) Tworzy nowy typ raportów z podanymi parametrami.
java.lang.Long	addType(java.lang.String typeName, java.lang.String categoryId, java.lang.String defaultFileName, java.lang.String defaultMimeType, java.lang.Long defaultGenerationPriority, java.lang.Boolean canImmediateExecute, java.lang.Boolean isActive, java.lang.Boolean isFileNameTimestampAdded, java.lang.String defaultGenerationMethod, java.lang.Boolean compressAfterGeneration) Tworzy nowy typ raportów z podanymi parametrami.
void	append(byte[] content) Dołącza podaną treść do właśnie wykonywanego raportu.
void	append(java.lang.String content) Dołącza podaną treść do właśnie wykonywanego raportu.
void	append(java.lang.String content, java.lang.String charsetEncoding) Dołącza podaną treść do właśnie wykonywanego raportu.
void	appendCRLF() Dołącza do treści raportu znak końca lini w stylu dosowo-windowsowym (CR LF, ascii 13 10).
void	appendLF() Dołącza do treści raportu znak końca lini w stylu uniksowym (LF, ascii 10).
java.lang.Boolean	cancelReport(java.lang.Long reportId) Próbuje anulować zamówienie na raport o podanym id.
java.lang.String	compressedReportURL(java.lang.Long reportId) Zwraca URL do raportu o podanym id w wersji skompresowanej.
void	compressReport(java.lang.Long reportId) Kompresuje raport o podanym id.
java.lang.String	createOrReplaceHtmlInterface() Tworzy interfejs HTML (zestaw obiektów palio z tym interfejsem) do zarządzania, zlecania i pobierania raportów.
java.lang.Long	executeFirstReport() Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport i wykonuje go.
java.lang.Long	executeFirstReport(java.lang.Boolean ignorePriority) Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport i wykonuje go.
java.lang.Long	executeFirstReport(java.lang.Long reportType) Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport danego typu i wykonuje go.
java.lang.Long	executeFirstReport(java.lang.Long reportType, java.lang.Boolean ignorePriority) Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport danego typu i wykonuje go.
java.lang.Long	executeFirstReport(java.lang.String reportCategory) Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport z danej kategorii i wykonuje go.
java.lang.Long	executeFirstReport(java.lang.String reportCategory, java.lang.Boolean ignorePriority) Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport z danej kategorii i wykonuje go.
java.lang.Boolean	executeReport(java.lang.Long reportId) Próbuje wykonać zamówienie na raport o podanym id.
java.lang.String	getCategoryName(java.lang.String categoryId) Zwraca nazwę kategorii o podanym id.
java.lang.String	getConnectorName() Zwraca nazwę konektora do danych raportów.
java.lang.Long	getCurrentReportId() Zwraca id wykonywanego raportu.
java.lang.String	getFormattedFileSize(java.lang.Long fileSize, java.lang.String separator, java.lang.Long fractionDigits) Zwraca podany w B rozmiar pliku w odpowiednich jednostkach (B, kB, MB, itd), 1kB=1024B, 1MB=1024kB itd.
java.lang.Boolean	getReportCompressAfterGenerationFlag(java.lang.Long reportId) Zwraca, czy raport po wygenerowaniu zostanie od razu skompresowany dla zlecenia na raport o podanym id.
java.lang.Boolean	getReportCompressedAvailable(java.lang.Long reportId) Zwraca zwraca informację, czy dostępny jest raport w wersji skompresowanej.
java.lang.String	getReportCompressedMimeType(java.lang.Long reportId) Zwraca zwraca mime type pliku dla skompresowanego raportu o podanym id.
java.lang.String	getReportCompressedName(java.lang.Long reportId) Zwraca zwraca nazwę pliku dla skompresowanego raportu o podanym id.
java.lang.Long	getReportCompressedSize(java.lang.Long reportId) Zwraca zwraca rozmiar skompresowanego raportu o podanym id.
java.util.Date	getReportCreationDate(java.lang.Long reportId) Zwraca datę utworzenia zlecenia na raport o podanym id.
java.lang.Long	getReportCreationUserId(java.lang.Long reportId) Zwraca id uzytkownika, który utworzył zlecenie na raport o podanym id.
java.lang.String	getReportDescription(java.lang.Long reportId) Zwraca opis zlecenia na raport o podanym id.
java.lang.String	getReportFileMimeType(java.lang.Long reportId) Zwraca zwraca mime type pliku dla wygenerowanego raportu o podanym id.
java.lang.String	getReportFileName(java.lang.Long reportId) Zwraca zwraca nazwę pliku dla wygenerowanego raportu o podanym id.
java.lang.Boolean	getReportFileNameTimestampFlag(java.lang.Long reportId) Zwraca, czy do nazwy raportu był dołączony domyślnie znacznik czasowy dla zlecenia na raport o podanym id.
java.lang.Long	getReportFileSize(java.lang.Long reportId) Zwraca zwraca rozmiar wygenerowanego raportu o podanym id.
java.lang.String	getReportGenerationComment(java.lang.Long reportId) Zwraca zwraca treść błędu (stack trace), który ew. wystąpił podczas generacji raportu o podanym id.
java.lang.Boolean	getReportGenerationCorrectness(java.lang.Long reportId) Zwraca zwraca informację, czy treść raportu o podanym id jest poprawna, czy nie.
java.util.Date	getReportGenerationEnd(java.lang.Long reportId) Zwraca datę zakończenia generacji raportu o podanym id.
java.lang.Long	getReportGenerationMethod(java.lang.Long reportId) Zwraca metodę generacji dla zlecenia na raport o podanym id.
java.lang.Long	getReportGenerationPriority(java.lang.Long reportId) Zwraca priorytet zlecenia na raport o podanym id.
java.lang.String	getReportGenerationProgress(java.lang.Long reportId) Zwraca informację o postępie generacji raportu o podanym id.
java.util.Date	getReportGenerationProgressTimestamp(java.lang.Long reportId) Zwraca datę ostatniej aktualizacji informacji o postępie generacji raportu o podanym id.
java.util.Date	getReportGenerationStart(java.lang.Long reportId) Zwraca datę rozpoczęcia generacji raportu o podanym id.
java.lang.String	getReportState(java.lang.Long reportId) Zwraca stan zlecenia na raport o podanym id.
java.lang.String	getReportStateName(java.lang.Long reportId) Zwraca nazwę stanu zlecenia na raport o podanym id.
java.lang.Long	getReportType(java.lang.Long reportId) Zwraca id typu zlecenia na raport o podanym id.
java.lang.Boolean	getTypeActiveFlag(java.lang.Long typeId) Zwraca czy typ raportu jest aktywny czy nie.
java.lang.String	getTypeCategoryId(java.lang.Long typeId) Zwraca id kategorii dla typu raportu o podanym id.
java.lang.Boolean	getTypeCompressAfterGenerationFlag(java.lang.Long typeId) Zwraca czy raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy.
java.lang.String	getTypeDefaultFileName(java.lang.Long typeId) Zwraca domyślną nazwę pliku dla typu raportu o podanym id.
java.lang.String	getTypeDefaultGenerationMethod(java.lang.Long typeId) Zwraca domyślny sposób generacji dla typu raportu o podanym id.
java.lang.Long	getTypeDefaultGenerationPriority(java.lang.Long typeId) Zwraca domyślny priorytet raportu w kolejce dla typu raportu o podanym id.
java.lang.String	getTypeDefaultMimeType(java.lang.Long typeId) Zwraca domyślny mime type dla typu raportu o podanym id.
java.lang.String	getTypeDescription(java.lang.Long typeId) Zwraca opis typu raportu o podanym id.
java.lang.Boolean	getTypeFileNameTimestampFlag(java.lang.Long typeId) Zwraca czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy.
java.lang.Long	getTypeFormCheckObject(java.lang.Long typeId) Zwraca id obiektu sprawdzającego formularz parametrów dla typu raportu o podanym id.
java.lang.Long	getTypeFormDisplayObject(java.lang.Long typeId) Zwraca id obiektu wyświetlającego formularz parametrów dla typu raportu o podanym id.
java.lang.Long	getTypeFormInitObject(java.lang.Long typeId) Zwraca id obiektu inicjalizującego formularz parametrów dla typu raportu o podanym id.
java.lang.Long	getTypeFormSaveObject(java.lang.Long typeId) Zwraca id obiektu zapisującego formularz parametrów dla typu raportu o podanym id.
java.lang.Long	getTypeGenerationObject(java.lang.Long typeId) Zwraca id obiektu generującego raport dla typu raportu o podanym id.
java.lang.Boolean	getTypeImmediateExecutionFlag(java.lang.Long typeId) Zwraca czy raport danego typu można wykonać poza kolejką (na żądanie).
java.lang.String	getTypeName(java.lang.Long typeId) Zwraca nazwę typu raportu o podanym id.
java.lang.String	getVersion() Zwraca numer wersji modułu.
java.lang.Boolean	isReportReserved(java.lang.Long reportId) Zwraca true jeśli raport o podanym id jest zablokowany (właśnie wykonywany/kompresowany).
void	lockReport(java.lang.Long reportId) Zmienia stan zlecenia na raport na "zablokowany" (L).
void	removeCategory(java.lang.String categoryId) Usuwa kategorię raportów o podanym id.
void	removeType(java.lang.Long typeId) Usuwa typ raportów o podanym id.
java.lang.String	reportURL(java.lang.Long reportId) Zwraca URL do raportu o podanym id.
void	setCategoryName(java.lang.String categoryId, java.lang.String categoryName) Ustawia nazwę kategorii o podanym id.
void	setProgressInfo(java.lang.String progressInfo) Ustawia informację o postępie generacji raportu.
void	setTypeActiveFlag(java.lang.Long typeId, java.lang.Boolean isActive) Ustawia flagę aktywności dla typu raportu o podanym id.
void	setTypeCategoryId(java.lang.Long typeId, java.lang.String categoryId) Ustawia id kategorii dla typu raportu o podanym id.
void	setTypeCompressAfterGenerationFlag(java.lang.Long typeId, java.lang.Boolean compressAfterGeneration) Ustawia flagę mówiącą czy raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy.
void	setTypeDefaultFileName(java.lang.Long typeId, java.lang.String defaultFileName) Ustawia domyślną nazwę pliku dla typu raportu o podanym id.
void	setTypeDefaultGenerationMethod(java.lang.Long typeId, java.lang.String defaultGenerationMethod) Ustawia domyślny sposób generacji dla typu raportu o podanym id.
void	setTypeDefaultGenerationPriority(java.lang.Long typeId, java.lang.Long defaultGenerationPriority) Ustawia domyślny priorytet raportu w kolejce dla typu raportu o podanym id.
void	setTypeDefaultMimeType(java.lang.Long typeId, java.lang.String defaultMimeType) Ustawia domyślny mime type dla typu raportu o podanym id.
void	setTypeDescription(java.lang.Long typeId, java.lang.String typeDescription) Ustawia opis typu raportu o podanym id.
void	setTypeFileNameTimestampFlag(java.lang.Long typeId, java.lang.Boolean isFileNameTimestampAdded) Ustawia flagę mówiącą czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy.
void	setTypeFormCheckObject(java.lang.Long typeId, java.lang.Long formCheckObject) Ustawia id obiektu sprawdzającego formularz parametrów dla typu raportu o podanym id.
void	setTypeFormDisplayObject(java.lang.Long typeId, java.lang.Long formDisplayObject) Ustawia id obiektu wyświetlającego formularz parametrów dla typu raportu o podanym id.
void	setTypeFormInitObject(java.lang.Long typeId, java.lang.Long formInitObject) Ustawia id obiektu inicjalizującego formularz parametrów dla typu raportu o podanym id.
void	setTypeFormSaveObject(java.lang.Long typeId, java.lang.Long formSaveObject) Ustawia id obiektu zapisującego formularz parametrów dla typu raportu o podanym id.
void	setTypeGenerationObject(java.lang.Long typeId, java.lang.Long generationObject) Ustawia id obiektu generującego raport parametrów dla typu raportu o podanym id.
void	setTypeImmediateExecutionFlag(java.lang.Long typeId, java.lang.Boolean canImmediateExecute) Ustawia flagę mówiącą czy raport danego typu można wykonać poza kolejką (na żądanie).
void	setTypeName(java.lang.Long typeId, java.lang.String typeName) Ustawia nazwę typu raportu o podanym id.
void	truncateReportCompressedContent(java.lang.Long reportId) Usuwa skompresowaną treść raportu zastępując ją wpisem "truncated".
void	truncateReportContent(java.lang.Long reportId) Usuwa nieskompresowaną treść raportu zastępując ją wpisem "truncated".
void	unlockReport(java.lang.Long reportId) Zmienia stan zablokowanego zlecenia na raport na "gotowy" (R).

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

Report

public Report(Instance instance,
              java.util.Properties properties)

Konstruktor.

Parameters:

instance - instancja jPalio, w ramach której ma zostać utworzony obiekt modułu.

properties - parametry przekazane do modułu

Method Detail

getVersion

public java.lang.String getVersion()

Zwraca numer wersji modułu.

Specified by:

getVersion in class Module

Returns:

numer wersji modułu

getConnectorName

public java.lang.String getConnectorName()

Zwraca nazwę konektora do danych raportów.

Returns:

nazwa konektora do danych raportów

addCategory

public void addCategory(java.lang.String categoryId,
                        java.lang.String categoryName)
                 throws palio.PalioException

Tworzy nową kategorię raportów o podanym id i nazwie. Jeśli kategoria już istnieje, zmienia jej nazwę na podaną.

Parameters:

categoryId - tekstowe id dla nowej kategorii, jeśli puste lub null wyrzucany jest wyjątek

categoryName - nazwa dla nowej kategorii, jeśli puste lub null wyrzucany jest wyjątek

Throws:

palio.PalioException

addCategory

public void addCategory(java.lang.String categoryId)
                 throws palio.PalioException

Tworzy nową kategorię raportów o podanym id i nazwie takiej samej jak id. Jeśli kategoria już istnieje, zmienia jej nazwę na taką samą jak id.

Parameters:

categoryId - tekstowe id dla nowej kategorii, jeśli puste lub null wyrzucany jest wyjątek

Throws:

palio.PalioException

removeCategory

public void removeCategory(java.lang.String categoryId)
                    throws palio.PalioException

Usuwa kategorię raportów o podanym id. Gdy istnieją typy raportów przypisane do podanej kategorii, wyrzucany jest wyjątek. Jeśli kategoria nie istnieje, nic nie robi.

Parameters:

categoryId - tekstowe id usuwanej kategorii

Throws:

palio.PalioException

getCategoryName

public java.lang.String getCategoryName(java.lang.String categoryId)
                                 throws palio.PalioException

Zwraca nazwę kategorii o podanym id. Jeśli kategoria nie istnieje zwracany jest null.

Parameters:

categoryId - tekstowe id kategorii

Returns:

nazwa kategorii o podanym id

Throws:

palio.PalioException

setCategoryName

public void setCategoryName(java.lang.String categoryId,
                            java.lang.String categoryName)
                     throws palio.PalioException

Ustawia nazwę kategorii o podanym id. Jeśli kategoria nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

categoryId - tekstowe id kategorii

categoryName - tekstowe id kategorii

Throws:

palio.PalioException

addType

public java.lang.Long addType(java.lang.String typeName,
                              java.lang.String categoryId,
                              java.lang.String defaultFileName,
                              java.lang.String defaultMimeType,
                              java.lang.Long defaultGenerationPriority,
                              java.lang.Boolean canImmediateExecute,
                              java.lang.Boolean isActive,
                              java.lang.Boolean isFileNameTimestampAdded,
                              java.lang.String defaultGenerationMethod,
                              java.lang.Boolean compressAfterGeneration)
                       throws palio.PalioException

Tworzy nowy typ raportów z podanymi parametrami.

Parameters:

typeName - nazwa nowego typu raportów, jeśli null wyrzucany jest wyjątek

categoryId - kategoria, do której będzie należał dodawany typ

defaultFileName - domyślna nazwa wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

defaultMimeType - domyślny mime type wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

defaultGenerationPriority - domyślny priorytet nadawany nowemu zleceniu na raport danego typu, jeśli null wyrzucany jest wyjątek. Raporty o wyższym priorytecie są wykonywane jako pierwsze

canImmediateExecute - czy raport można wykonac z palca - pole dla interfejsu raportowego, które może zostac wykorzystane do oznaczenia tych raportów, które można wykonać poza kolejką (na żądanie)

isActive - czy nowy typ raportu będzie aktywny, jeśli null wyrzucany jest wyjątek

isFileNameTimestampAdded - czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy,

defaultGenerationMethod - jesli "MEMORY", to cały raport będzie tworzony w pamięci, jeśli "FILE", to zostanie utworzony tymczasowy plik na dysku (na maszynie z jPalio), który zostanie później wczytany do bazy i ew. skompresowany (pozwala pominąć ograniczenia pamięciowe). Jesli inna wartość, to tak jak dla "MEMORY".

compressAfterGeneration - jeśli true, to raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy

Returns:

id dodanego typu raportu

Throws:

palio.PalioException

addType

public java.lang.Long addType(java.lang.String typeName,
                              java.lang.String categoryId,
                              java.lang.String defaultFileName,
                              java.lang.String defaultMimeType,
                              java.lang.Long defaultGenerationPriority,
                              java.lang.Boolean canImmediateExecute,
                              java.lang.Boolean isActive,
                              java.lang.Boolean isFileNameTimestampAdded)
                       throws palio.PalioException

Tworzy nowy typ raportów z podanymi parametrami. Raport będzie tworzony w pamięci i nie będzie od razu kompresowany.

Parameters:

typeName - nazwa nowego typu raportów, jeśli null wyrzucany jest wyjątek

categoryId - kategoria, do której będzie należał dodawany typ

defaultFileName - domyślna nazwa wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

defaultMimeType - domyślny mime type wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

defaultGenerationPriority - domyślny priorytet nadawany nowemu zleceniu na raport danego typu, jeśli null wyrzucany jest wyjątek. Raporty o wyższym priorytecie są wykonywane jako pierwsze

canImmediateExecute - czy raport można wykonac z palca - pole dla interfejsu raportowego, które może zostac wykorzystane do oznaczenia tych raportów, które można wykonać poza kolejką (na żądanie)

isActive - czy nowy typ raportu będzie aktywny, jeśli null wyrzucany jest wyjątek

isFileNameTimestampAdded - czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy,

Returns:

id dodanego typu raportu

Throws:

palio.PalioException

addType

public java.lang.Long addType(java.lang.String typeName,
                              java.lang.String categoryId,
                              java.lang.String defaultFileName,
                              java.lang.String defaultMimeType,
                              java.lang.Long defaultGenerationPriority)
                       throws palio.PalioException

Tworzy nowy typ raportów z podanymi parametrami. Utworzony typ raportów jest aktywny i ma ustawioną flagę, że można go wykonać poza kolejką. Do nazwy raportu będzie dodawany znacznik czasowy. Raport będzie tworzony w pamięci i nie będzie od razu kompresowany.

Parameters:

typeName - nazwa nowego typu raportów, jeśli null wyrzucany jest wyjątek

categoryId - kategoria, do której będzie należał dodawany typ

defaultFileName - domyślna nazwa wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

defaultMimeType - domyślny mime type wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

defaultGenerationPriority - domyślny priorytet nadawany nowemu zleceniu na raport danego typu, jeśli null wyrzucany jest wyjątek. Raporty o wyższym priorytecie są wykonywane jako pierwsze

Returns:

id dodanego typu raportu

Throws:

palio.PalioException

addType

public java.lang.Long addType(java.lang.String typeName,
                              java.lang.String categoryId,
                              java.lang.String defaultFileName,
                              java.lang.String defaultMimeType)
                       throws palio.PalioException

Tworzy nowy typ raportów z podanymi parametrami. Utworzony typ raportów jest aktywny, ma domyślny priorytet (0) i ma ustawioną flagę, że można go wykonać poza kolejką. Do nazwy raportu będzie dodawany znacznik czasowy. Raport będzie tworzony w pamięci i nie będzie od razu kompresowany.

Parameters:

typeName - nazwa nowego typu raportów, jeśli null wyrzucany jest wyjątek

categoryId - kategoria, do której będzie należał dodawany typ

defaultFileName - domyślna nazwa wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

defaultMimeType - domyślny mime type wygenerowanych raportów danego typu, jeśli null wyrzucany jest wyjątek

Returns:

id dodanego typu raportu

Throws:

palio.PalioException

addType

public java.lang.Long addType(java.lang.String typeName,
                              java.lang.String categoryId)
                       throws palio.PalioException

Tworzy nowy typ raportów z podanymi parametrami. Utworzony typ raportów jest aktywny, ma domyślny priorytet (0), domyślną nazwę pliku "report", domyślny mime type "text/csv" i ma ustawioną flagę, że można go wykonać poza kolejką. Do nazwy raportu będzie dodawany znacznik czasowy. Raport będzie tworzony w pamięci i nie będzie od razu kompresowany.

Parameters:

typeName - nazwa nowego typu raportów, jeśli null wyrzucany jest wyjątek

categoryId - kategoria, do której będzie należał dodawany typ

Returns:

id dodanego typu raportu

Throws:

palio.PalioException

removeType

public void removeType(java.lang.Long typeId)
                throws palio.PalioException

Usuwa typ raportów o podanym id. Gdy istnieją raporty przypisane do podanego typu, wyrzucany jest wyjątek. Jeśli typ nie istnieje, nic nie robi.

Parameters:

typeId - id usuwanego typu

Throws:

palio.PalioException

getTypeName

public java.lang.String getTypeName(java.lang.Long typeId)
                             throws palio.PalioException

Zwraca nazwę typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

nazwa typu o podanym id

Throws:

palio.PalioException

setTypeName

public void setTypeName(java.lang.Long typeId,
                        java.lang.String typeName)
                 throws palio.PalioException

Ustawia nazwę typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

typeName - nowa nazwa typu

Throws:

palio.PalioException

getTypeCategoryId

public java.lang.String getTypeCategoryId(java.lang.Long typeId)
                                   throws palio.PalioException

Zwraca id kategorii dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

id kategorii dla typu o podanym id

Throws:

palio.PalioException

setTypeCategoryId

public void setTypeCategoryId(java.lang.Long typeId,
                              java.lang.String categoryId)
                       throws palio.PalioException

Ustawia id kategorii dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

categoryId - nowe id kategorii dla typu

Throws:

palio.PalioException

getTypeActiveFlag

public java.lang.Boolean getTypeActiveFlag(java.lang.Long typeId)
                                    throws palio.PalioException

Zwraca czy typ raportu jest aktywny czy nie. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

flaga aktywności typu raportu o podanym id

Throws:

palio.PalioException

setTypeActiveFlag

public void setTypeActiveFlag(java.lang.Long typeId,
                              java.lang.Boolean isActive)
                       throws palio.PalioException

Ustawia flagę aktywności dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

isActive - jeśli true raport oznaczany jest jako aktywny

Throws:

palio.PalioException

getTypeDescription

public java.lang.String getTypeDescription(java.lang.Long typeId)
                                    throws palio.PalioException

Zwraca opis typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

opis typu o podanym id

Throws:

palio.PalioException

setTypeDescription

public void setTypeDescription(java.lang.Long typeId,
                               java.lang.String typeDescription)
                        throws palio.PalioException

Ustawia opis typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

typeDescription - nowy opis typu

Throws:

palio.PalioException

getTypeDefaultFileName

public java.lang.String getTypeDefaultFileName(java.lang.Long typeId)
                                        throws palio.PalioException

Zwraca domyślną nazwę pliku dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

domyślna nazwa pliku dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeDefaultFileName

public void setTypeDefaultFileName(java.lang.Long typeId,
                                   java.lang.String defaultFileName)
                            throws palio.PalioException

Ustawia domyślną nazwę pliku dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

defaultFileName - nowa domyślna nazwa pliku dla typu raportu

Throws:

palio.PalioException

getTypeFileNameTimestampFlag

public java.lang.Boolean getTypeFileNameTimestampFlag(java.lang.Long typeId)
                                               throws palio.PalioException

Zwraca czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

flaga mówiąca, czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy

Throws:

palio.PalioException

setTypeFileNameTimestampFlag

public void setTypeFileNameTimestampFlag(java.lang.Long typeId,
                                         java.lang.Boolean isFileNameTimestampAdded)
                                  throws palio.PalioException

Ustawia flagę mówiącą czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

isFileNameTimestampAdded - czy do nazw raportu danego typu dołączany jest domyślnie znacznik czasowy,

Throws:

palio.PalioException

getTypeDefaultMimeType

public java.lang.String getTypeDefaultMimeType(java.lang.Long typeId)
                                        throws palio.PalioException

Zwraca domyślny mime type dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

domyślny mime type dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeDefaultMimeType

public void setTypeDefaultMimeType(java.lang.Long typeId,
                                   java.lang.String defaultMimeType)
                            throws palio.PalioException

Ustawia domyślny mime type dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

defaultMimeType - nowy domyślny mime type dla typu

Throws:

palio.PalioException

getTypeDefaultGenerationPriority

public java.lang.Long getTypeDefaultGenerationPriority(java.lang.Long typeId)
                                                throws palio.PalioException

Zwraca domyślny priorytet raportu w kolejce dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

domyślny priorytet raportu w kolejce dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeDefaultGenerationPriority

public void setTypeDefaultGenerationPriority(java.lang.Long typeId,
                                             java.lang.Long defaultGenerationPriority)
                                      throws palio.PalioException

Ustawia domyślny priorytet raportu w kolejce dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

defaultGenerationPriority - nowy domyślny priorytet raportu w kolejce dla typu raportu. Raporty o wyższym priorytecie są wykonywane jako pierwsze

Throws:

palio.PalioException

getTypeDefaultGenerationMethod

public java.lang.String getTypeDefaultGenerationMethod(java.lang.Long typeId)
                                                throws palio.PalioException

Zwraca domyślny sposób generacji dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

domyślny sposób generacji dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeDefaultGenerationMethod

public void setTypeDefaultGenerationMethod(java.lang.Long typeId,
                                           java.lang.String defaultGenerationMethod)
                                    throws palio.PalioException

Ustawia domyślny sposób generacji dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

defaultGenerationMethod - nowy domyślny sposób generacji dla typu

Throws:

palio.PalioException

getTypeCompressAfterGenerationFlag

public java.lang.Boolean getTypeCompressAfterGenerationFlag(java.lang.Long typeId)
                                                     throws palio.PalioException

Zwraca czy raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

flaga mówiąca, czy raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy

Throws:

palio.PalioException

setTypeCompressAfterGenerationFlag

public void setTypeCompressAfterGenerationFlag(java.lang.Long typeId,
                                               java.lang.Boolean compressAfterGeneration)
                                        throws palio.PalioException

Ustawia flagę mówiącą czy raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

compressAfterGeneration - czy raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy,

Throws:

palio.PalioException

getTypeFormInitObject

public java.lang.Long getTypeFormInitObject(java.lang.Long typeId)
                                     throws palio.PalioException

Zwraca id obiektu inicjalizującego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

id obiektu inicjalizującego formularz parametrów dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeFormInitObject

public void setTypeFormInitObject(java.lang.Long typeId,
                                  java.lang.Long formInitObject)
                           throws palio.PalioException

Ustawia id obiektu inicjalizującego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

formInitObject - id obiektu inicjalizującego formularz parametrów dla typu raportu

Throws:

palio.PalioException

getTypeFormDisplayObject

public java.lang.Long getTypeFormDisplayObject(java.lang.Long typeId)
                                        throws palio.PalioException

Zwraca id obiektu wyświetlającego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

id obiektu wyświetlającego formularz parametrów dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeFormDisplayObject

public void setTypeFormDisplayObject(java.lang.Long typeId,
                                     java.lang.Long formDisplayObject)
                              throws palio.PalioException

Ustawia id obiektu wyświetlającego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

formDisplayObject - id obiektu wyświetlającego formularz parametrów dla typu raportu

Throws:

palio.PalioException

getTypeFormCheckObject

public java.lang.Long getTypeFormCheckObject(java.lang.Long typeId)
                                      throws palio.PalioException

Zwraca id obiektu sprawdzającego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

id obiektu sprawdzającego formularz parametrów dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeFormCheckObject

public void setTypeFormCheckObject(java.lang.Long typeId,
                                   java.lang.Long formCheckObject)
                            throws palio.PalioException

Ustawia id obiektu sprawdzającego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

formCheckObject - id obiektu sprawdzającego formularz parametrów dla typu raportu

Throws:

palio.PalioException

getTypeFormSaveObject

public java.lang.Long getTypeFormSaveObject(java.lang.Long typeId)
                                     throws palio.PalioException

Zwraca id obiektu zapisującego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

id obiektu zapisującego formularz parametrów dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeFormSaveObject

public void setTypeFormSaveObject(java.lang.Long typeId,
                                  java.lang.Long formSaveObject)
                           throws palio.PalioException

Ustawia id obiektu zapisującego formularz parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

formSaveObject - id obiektu zapisującego formularz parametrów dla typu raportu

Throws:

palio.PalioException

getTypeGenerationObject

public java.lang.Long getTypeGenerationObject(java.lang.Long typeId)
                                       throws palio.PalioException

Zwraca id obiektu generującego raport dla typu raportu o podanym id. Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

id obiektu generującego raport dla typu raportu o podanym id

Throws:

palio.PalioException

setTypeGenerationObject

public void setTypeGenerationObject(java.lang.Long typeId,
                                    java.lang.Long generationObject)
                             throws palio.PalioException

Ustawia id obiektu generującego raport parametrów dla typu raportu o podanym id. Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

generationObject - id generującego raport formularz parametrów dla typu raportu

Throws:

palio.PalioException

getTypeImmediateExecutionFlag

public java.lang.Boolean getTypeImmediateExecutionFlag(java.lang.Long typeId)
                                                throws palio.PalioException

Zwraca czy raport danego typu można wykonać poza kolejką (na żądanie). Jeśli typ nie istnieje zwracany jest null.

Parameters:

typeId - id typu

Returns:

flaga mówiąca, czy raport danego typu można wykonać poza kolejką (na żądanie)

Throws:

palio.PalioException

setTypeImmediateExecutionFlag

public void setTypeImmediateExecutionFlag(java.lang.Long typeId,
                                          java.lang.Boolean canImmediateExecute)
                                   throws palio.PalioException

Ustawia flagę mówiącą czy raport danego typu można wykonać poza kolejką (na żądanie). Jeśli typ nie istnieje, żaden wyjątek nie jest wyrzucany.

Parameters:

typeId - id typu

canImmediateExecute - czy raport można wykonac z palca - pole dla interfejsu raportowego, które może zostac wykorzystane do oznaczenia tych raportów, które można wykonać poza kolejką (na żądanie)

Throws:

palio.PalioException

addReport

public java.lang.Long addReport(java.lang.Long typeId,
                                java.lang.Object[] paramNames,
                                java.lang.String description,
                                java.lang.Long generationPriority,
                                java.lang.String fileName,
                                java.lang.Boolean addTimestampToFileName,
                                java.lang.String mimeType,
                                java.lang.String generationMethod,
                                java.lang.Boolean compressAfterGeneration)
                         throws palio.PalioException

Dodaje zlecenie na raport z określonymi parametrami raportu, opisem, priorytetem generacji oraz nazwą i mime type pliku wynikowego. Raport jest ustawiany w stan O (zamówiony). Jeśli priorytet, nazwa pliku, mime type, flaga znacznika czasowego w nazwie, metoda generacji lub flaga kompresji po generacji są null, to ich wartości są ustawiane na domyślne z r_types.

Parameters:

typeId - id typu dodawanego raportu, jeśli null wyrzucany jest wyjątek

paramNames - tabela z nazwami zmiennych , których wartości zostaną zapisane jako parametry raportu. W wartości zmiennych nie może być znaku #, używanego do rozdzielania nazw i wartości parametrów w polu r_orders.report_params w bazie. przekazanie w tym polu null oznacza raport bez parametrów.

description - komentarz do twozonego zlecenia na raport.

generationPriority - piorytet generacji raportu - raporty o wyższym priorytecie są wykonywane jako pierwsze. Jeśli null to priorytet jest ustalany na domyślny przypisany do danego typu raportu.

fileName - nazwa pliku z raportem, jeśli null, to ustalana na domyślną przypisaną do danego typu raportu.

addTimestampToFileName - jeśli true, to w momencie rozpoczęcia generacji raortu moduł próbuje rozdzielić fileName na nazwę i rozszerzenie i dodać na końcu nazwy znacznik czasowy w formacie _yyyy_MM_dd_hh_mm_ss. Jeśli w fileName nie ma rozszerzenia, znacznik dodawany jest na końcu nazwy. Jeśli null, to flaga ustalana jest na domyślną wartość przypisaną do danego typu raportu.

mimeType - mime type dla pliku z raportem, jeśli null, to ustalany na domyślny przypisany do danego typu raportu.

generationMethod - jeśli "MEMORY", to cały raport będzie tworzony w pamięci, jeśli "FILE", to zostanie utworzony tymczasowy plik na dysku (na maszynie z jPalio), który zostanie później wczytany do bazy i ew. skompresowany (pozwala pominąć ograniczenia pamięciowe). Jesli inna wartość, to tak jak dla "MEMORY".

compressAfterGeneration - jeśli true, to raport po wygenerowaniu zostanie od razu skompresowany i zapisany do bazy

Returns:

id dodanego zlecenia na raport

Throws:

palio.PalioException

addReport

public java.lang.Long addReport(java.lang.Long typeId,
                                java.lang.Object[] paramNames,
                                java.lang.String description,
                                java.lang.Long generationPriority,
                                java.lang.String fileName)
                         throws palio.PalioException

Dodaje zlecenie na raport z określonymi parametrami raportu, opisem, priorytetem generacji oraz nazwą pliku wynikowego. Mime type, znacznik czasowy w nazwie, sposób generacji i flaga kompresji po generacji są ustawiane na domyślne. Raport jest ustawiany w stan O (zamówiony). Jeśli priorytet lub nazwa pliku w nazwie są null, to ich wartości są ustawiane na domyślne z r_types.

Parameters:

typeId - id typu dodawanego raportu, jeśli null wyrzucany jest wyjątek

paramNames - tabela z nazwami zmiennych , których wartości zostaną zapisane jako parametry raportu. W wartości zmiennych nie może być znaku #, używanego do rozdzielania nazw i wartości parametrów w polu r_orders.report_params w bazie. przekazanie w tym polu null oznacza raport bez parametrów.

description - komentarz do twozonego zlecenia na raport.

generationPriority - piorytet generacji raportu - raporty o wyższym priorytecie są wykonywane jako pierwsze. Jeśli null to priorytet jest ustalany na domyślny przypisany do danego typu raportu.

fileName - nazwa pliku z raportem, jeśli null, to ustalana na domyślną przypisaną do danego typu raportu.

Returns:

id dodanego zlecenia na raport

Throws:

palio.PalioException

addReport

public java.lang.Long addReport(java.lang.Long typeId,
                                java.lang.Object[] paramNames,
                                java.lang.String description)
                         throws palio.PalioException

Dodaje zlecenie na raport z określonymi parametrami raportu oraz opisem. Mime type, nazwa pliku, znacznik czasowy w nazwie, priorytet generacji, sposób generacji i flaga kompresji po generacji są ustawiane na domyślne. Raport jest ustawiany w stan O (zamówiony).

Parameters:

typeId - id typu dodawanego raportu, jeśli null wyrzucany jest wyjątek

paramNames - tabela z nazwami zmiennych , których wartości zostaną zapisane jako parametry raportu. W wartości zmiennych nie może być znaku #, używanego do rozdzielania nazw i wartości parametrów w polu r_orders.report_params w bazie. przekazanie w tym polu null oznacza raport bez parametrów.

description - komentarz do twozonego zlecenia na raport.

Returns:

id dodanego zlecenia na raport

Throws:

palio.PalioException

cancelReport

public java.lang.Boolean cancelReport(java.lang.Long reportId)
                               throws palio.PalioException

Próbuje anulować zamówienie na raport o podanym id.

Parameters:

reportId - id raportu do anulowania

Returns:

true, jeśli anulowano raport, false jeśli nie udało się anulować raportu (jest już wykonywany lub jest w niewłaściwym stanie, innym niż 'O').

Throws:

palio.PalioException

lockReport

public void lockReport(java.lang.Long reportId)
                throws palio.PalioException

Zmienia stan zlecenia na raport na "zablokowany" (L). Zmieniany jest tylko stan raportów znajdujących się w stanie "gotowy" (R).

Parameters:

reportId - id raportu do zablokowania

Throws:

palio.PalioException

unlockReport

public void unlockReport(java.lang.Long reportId)
                  throws palio.PalioException

Zmienia stan zablokowanego zlecenia na raport na "gotowy" (R). Zmieniany jest tylko stan raportów znajdujących się w stanie "zablokowany" (L).

Parameters:

reportId - id raportu do odblokowania

Throws:

palio.PalioException

getReportState

public java.lang.String getReportState(java.lang.Long reportId)
                                throws palio.PalioException

Zwraca stan zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

stan zlecenia

Throws:

palio.PalioException

getReportStateName

public java.lang.String getReportStateName(java.lang.Long reportId)
                                    throws palio.PalioException

Zwraca nazwę stanu zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

nazwa stanu zlecenia

Throws:

palio.PalioException

getReportType

public java.lang.Long getReportType(java.lang.Long reportId)
                             throws palio.PalioException

Zwraca id typu zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

id typu zlecenia na raport

Throws:

palio.PalioException

getReportDescription

public java.lang.String getReportDescription(java.lang.Long reportId)
                                      throws palio.PalioException

Zwraca opis zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

opis zlecenia na raport

Throws:

palio.PalioException

getReportCreationDate

public java.util.Date getReportCreationDate(java.lang.Long reportId)
                                     throws palio.PalioException

Zwraca datę utworzenia zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

data utworzenia zlecenia na raport

Throws:

palio.PalioException

getReportCreationUserId

public java.lang.Long getReportCreationUserId(java.lang.Long reportId)
                                       throws palio.PalioException

Zwraca id uzytkownika, który utworzył zlecenie na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

id uzytkownika, który utworzył zlecenie na raport

Throws:

palio.PalioException

getReportGenerationPriority

public java.lang.Long getReportGenerationPriority(java.lang.Long reportId)
                                           throws palio.PalioException

Zwraca priorytet zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

priorytet zlecenia na raport

Throws:

palio.PalioException

getReportFileNameTimestampFlag

public java.lang.Boolean getReportFileNameTimestampFlag(java.lang.Long reportId)
                                                 throws palio.PalioException

Zwraca, czy do nazwy raportu był dołączony domyślnie znacznik czasowy dla zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

true, jeśli do nazwy raportu był dołączony domyślnie znacznik czasowy

Throws:

palio.PalioException

getReportGenerationMethod

public java.lang.Long getReportGenerationMethod(java.lang.Long reportId)
                                         throws palio.PalioException

Zwraca metodę generacji dla zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

metoda generacji dla zlecenia na raport

Throws:

palio.PalioException

getReportCompressAfterGenerationFlag

public java.lang.Boolean getReportCompressAfterGenerationFlag(java.lang.Long reportId)
                                                       throws palio.PalioException

Zwraca, czy raport po wygenerowaniu zostanie od razu skompresowany dla zlecenia na raport o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

true, jeśli raport po wygenerowaniu zostanie od razu skompresowany

Throws:

palio.PalioException

getReportGenerationStart

public java.util.Date getReportGenerationStart(java.lang.Long reportId)
                                        throws palio.PalioException

Zwraca datę rozpoczęcia generacji raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

data rozpoczęcia generacji raportu

Throws:

palio.PalioException

getReportGenerationEnd

public java.util.Date getReportGenerationEnd(java.lang.Long reportId)
                                      throws palio.PalioException

Zwraca datę zakończenia generacji raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

data zakończenia generacji raportu

Throws:

palio.PalioException

getReportGenerationProgress

public java.lang.String getReportGenerationProgress(java.lang.Long reportId)
                                             throws palio.PalioException

Zwraca informację o postępie generacji raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

informacja o postępie generacji raportu

Throws:

palio.PalioException

getReportGenerationProgressTimestamp

public java.util.Date getReportGenerationProgressTimestamp(java.lang.Long reportId)
                                                    throws palio.PalioException

Zwraca datę ostatniej aktualizacji informacji o postępie generacji raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

datę ostatniej aktualizacji informacji o postępie generacji raportu

Throws:

palio.PalioException

getReportGenerationCorrectness

public java.lang.Boolean getReportGenerationCorrectness(java.lang.Long reportId)
                                                 throws palio.PalioException

Zwraca zwraca informację, czy treść raportu o podanym id jest poprawna, czy nie.

Parameters:

reportId - id zlecenia na raport

Returns:

true jeśli treść raportu o podanym id jest poprawna

Throws:

palio.PalioException

getReportGenerationComment

public java.lang.String getReportGenerationComment(java.lang.Long reportId)
                                            throws palio.PalioException

Zwraca zwraca treść błędu (stack trace), który ew. wystąpił podczas generacji raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

treść błędu, który ew. wystąpił podczas generacji raportu

Throws:

palio.PalioException

getReportFileSize

public java.lang.Long getReportFileSize(java.lang.Long reportId)
                                 throws palio.PalioException

Zwraca zwraca rozmiar wygenerowanego raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

rozmiar wygenerowanego raportu (w bajtach)

Throws:

palio.PalioException

getReportFileName

public java.lang.String getReportFileName(java.lang.Long reportId)
                                   throws palio.PalioException

Zwraca zwraca nazwę pliku dla wygenerowanego raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

nazwa pliku dla wygenerowanego raportu

Throws:

palio.PalioException

getReportFileMimeType

public java.lang.String getReportFileMimeType(java.lang.Long reportId)
                                       throws palio.PalioException

Zwraca zwraca mime type pliku dla wygenerowanego raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

mime type pliku dla wygenerowanego raportu

Throws:

palio.PalioException

getReportCompressedAvailable

public java.lang.Boolean getReportCompressedAvailable(java.lang.Long reportId)
                                               throws palio.PalioException

Zwraca zwraca informację, czy dostępny jest raport w wersji skompresowanej.

Parameters:

reportId - id zlecenia na raport

Returns:

true jeśli dostępny jest raport w wersji skompresowanej

Throws:

palio.PalioException

getReportCompressedSize

public java.lang.Long getReportCompressedSize(java.lang.Long reportId)
                                       throws palio.PalioException

Zwraca zwraca rozmiar skompresowanego raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

rozmiar skompresowanego raportu (w bajtach)

Throws:

palio.PalioException

getReportCompressedName

public java.lang.String getReportCompressedName(java.lang.Long reportId)
                                         throws palio.PalioException

Zwraca zwraca nazwę pliku dla skompresowanego raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

nazwa pliku dla skompresowanego raportu

Throws:

palio.PalioException

getReportCompressedMimeType

public java.lang.String getReportCompressedMimeType(java.lang.Long reportId)
                                             throws palio.PalioException

Zwraca zwraca mime type pliku dla skompresowanego raportu o podanym id.

Parameters:

reportId - id zlecenia na raport

Returns:

mime type pliku dla skompresowanego raportu

Throws:

palio.PalioException

executeFirstReport

public java.lang.Long executeFirstReport(java.lang.String reportCategory,
                                         java.lang.Boolean ignorePriority)
                                  throws palio.PalioException,
                                         java.io.UnsupportedEncodingException,
                                         java.io.IOException

Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport z danej kategorii i wykonuje go.

Parameters:

reportCategory - kategoria do której ma należeć wybrany raport

ignorePriority - flaga mówiąca, czy ignorować kolejność generacji ustaloną przez priorytety. Jeśli true, to raporty są wykonywane w kolejności dodawania, jeśli false, to najpierw z wyższym priorytetem, a w ramach priorytetu wg. kolejności wykonania.

Returns:

id zgłoszenia na raport, które zostało wykonane lub null, jeśli nie znaleziono żadnego raportu do wykonania.

Throws:

palio.PalioException

java.io.UnsupportedEncodingException

java.io.IOException

executeFirstReport

public java.lang.Long executeFirstReport(java.lang.String reportCategory)
                                  throws palio.PalioException,
                                         java.io.UnsupportedEncodingException,
                                         java.io.IOException

Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport z danej kategorii i wykonuje go. Bierze pod uwagę priorytety raportów.

Parameters:

reportCategory - kategoria do której ma należeć wybrany raport

Returns:

id zgłoszenia na raport, które zostało wykonane lub null, jeśli nie znaleziono żadnego raportu do wykonania.

Throws:

palio.PalioException

java.io.UnsupportedEncodingException

java.io.IOException

executeFirstReport

public java.lang.Long executeFirstReport(java.lang.Long reportType,
                                         java.lang.Boolean ignorePriority)
                                  throws palio.PalioException,
                                         java.io.UnsupportedEncodingException,
                                         java.io.IOException

Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport danego typu i wykonuje go.

Parameters:

reportType - typ do którego ma należeć wybrany raport

ignorePriority - flaga mówiąca, czy ignorować kolejność generacji ustaloną przez priorytety. Jeśli true, to raporty są wykonywane w kolejności dodawania, jeśli false, to najpierw z wyższym priorytetem, a w ramach priorytetu wg. kolejności wykonania.

Returns:

id zgłoszenia na raport, które zostało wykonane lub null, jeśli nie znaleziono żadnego raportu do wykonania.

Throws:

palio.PalioException

java.io.UnsupportedEncodingException

java.io.IOException

executeFirstReport

public java.lang.Long executeFirstReport(java.lang.Long reportType)
                                  throws palio.PalioException,
                                         java.io.UnsupportedEncodingException,
                                         java.io.IOException

Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport danego typu i wykonuje go. Bierze pod uwagę priorytety raportów.

Parameters:

reportType - typ do którego ma należeć wybrany raport

Returns:

id zgłoszenia na raport, które zostało wykonane lub null, jeśli nie znaleziono żadnego raportu do wykonania.

Throws:

palio.PalioException

java.io.UnsupportedEncodingException

java.io.IOException

executeFirstReport

public java.lang.Long executeFirstReport(java.lang.Boolean ignorePriority)
                                  throws palio.PalioException,
                                         java.io.UnsupportedEncodingException,
                                         java.io.IOException

Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport i wykonuje go.

Parameters:

ignorePriority - flaga mówiąca, czy ignorować kolejność generacji ustaloną przez priorytety. Jeśli true, to raporty są wykonywane w kolejności dodawania, jeśli false, to najpierw z wyższym priorytetem, a w ramach priorytetu wg. kolejności wykonania.

Returns:

id zgłoszenia na raport, które zostało wykonane lub null, jeśli nie znaleziono żadnego raportu do wykonania.

Throws:

palio.PalioException

java.io.UnsupportedEncodingException

java.io.IOException

executeFirstReport

public java.lang.Long executeFirstReport()
                                  throws palio.PalioException,
                                         java.io.UnsupportedEncodingException,
                                         java.io.IOException

Wybiera pierwsze nie wykonywane jeszcze zamówienie na raport i wykonuje go.

Returns:

id zgłoszenia na raport, które zostało wykonane lub null, jeśli nie znaleziono żadnego raportu do wykonania.

Throws:

palio.PalioException

java.io.UnsupportedEncodingException

java.io.IOException

executeReport

public java.lang.Boolean executeReport(java.lang.Long reportId)
                                throws palio.PalioException,
                                       java.io.UnsupportedEncodingException,
                                       java.io.IOException

Próbuje wykonać zamówienie na raport o podanym id. Nie jest brana pod uwagę flaga r_types.can_immediate_execute.

Parameters:

reportId - id raportu do wykonania

Returns:

true, jeśli zarezerwowano raport i wykonano go (niezależnie od poprawności wykonania), false jeśli nie można zarezerwować raportu (jest już zarezerwowany lub jest w niewłaściwym stanie, innym niż 'O').

Throws:

palio.PalioException

java.io.UnsupportedEncodingException

java.io.IOException

isReportReserved

public java.lang.Boolean isReportReserved(java.lang.Long reportId)

Zwraca true jeśli raport o podanym id jest zablokowany (właśnie wykonywany/kompresowany).

Parameters:

reportId - id raportu, którego rezerwacja ma byc sprawdzona

Returns:

true jeśli raport o podanym id jest zablokowany (właśnie wykonywany/kompresowany).

getCurrentReportId

public java.lang.Long getCurrentReportId()

Zwraca id wykonywanego raportu.

Returns:

Id właśnie wykonywanego raportu. Wartości są różne od null tylko dla wywołań z obiektu generującego raport.

append

public void append(java.lang.String content,
                   java.lang.String charsetEncoding)
            throws palio.PalioException,
                   java.io.UnsupportedEncodingException,
                   java.io.IOException

Dołącza podaną treść do właśnie wykonywanego raportu. Wywołanie jest skuteczne tylko w obiekcie generującym raport.

Parameters:

content - treść do dołączenia do raportu

charsetEncoding - strona kodowa, wg której String zostanie przekształcony na tablicę bajtów

Throws:

palio.PalioException

java.io.IOException

java.io.UnsupportedEncodingException

append

public void append(java.lang.String content)
            throws palio.PalioException,
                   java.io.UnsupportedEncodingException,
                   java.io.IOException

Dołącza podaną treść do właśnie wykonywanego raportu. Wywołanie jest skuteczne tylko w obiekcie generującym raport.

Parameters:

content - treść do dołączenia do raportu

Throws:

palio.PalioException

java.io.IOException

java.io.UnsupportedEncodingException

append

public void append(byte[] content)
            throws palio.PalioException,
                   java.io.IOException

Dołącza podaną treść do właśnie wykonywanego raportu. Wywołanie jest skuteczne tylko w obiekcie generującym raport.

Parameters:

content - treść do dołączenia do raportu

Throws:

palio.PalioException

java.io.IOException

java.io.UnsupportedEncodingException

appendCRLF

public void appendCRLF()
                throws palio.PalioException,
                       java.io.UnsupportedEncodingException,
                       java.io.IOException

Dołącza do treści raportu znak końca lini w stylu dosowo-windowsowym (CR LF, ascii 13 10). Wywołanie jest skuteczne tylko w obiekcie generującym raport.

Throws:

palio.PalioException

java.io.IOException

java.io.UnsupportedEncodingException

appendLF

public void appendLF()
              throws palio.PalioException,
                     java.io.UnsupportedEncodingException,
                     java.io.IOException

Dołącza do treści raportu znak końca lini w stylu uniksowym (LF, ascii 10). Wywołanie jest skuteczne tylko w obiekcie generującym raport.

Throws:

palio.PalioException

java.io.IOException

java.io.UnsupportedEncodingException

setProgressInfo

public void setProgressInfo(java.lang.String progressInfo)
                     throws palio.PalioException

Ustawia informację o postępie generacji raportu. Wywołanie jest skuteczne tylko w obiekcie generującym raport.

Parameters:

progressInfo - informacja do ustawienia

Throws:

palio.PalioException

compressReport

public void compressReport(java.lang.Long reportId)
                    throws palio.PalioException,
                           java.io.IOException

Kompresuje raport o podanym id. Kompresowanie jest skuteczne tylko dla poprawnie wygenerowanych raportów w stanie gotowy (R) lub zablokowany (L), które jeszcze nie były kompresowane. Metoda zabezpiecza przed jednoczesnym kompresowaniem podanego raportu przez różne wątki jednej instancji jpalio. Kompresowanie odbywa się przez wczytanie nieskompresowanego raportu do pamięci, kompresję w pamięci i zapis do bazy, dlatego trzeba uważać na ilość wolnej pamięci.

Parameters:

reportId - id raportu do skompresowania

Throws:

palio.PalioException

java.io.IOException

truncateReportContent

public void truncateReportContent(java.lang.Long reportId)
                           throws palio.PalioException

Usuwa nieskompresowaną treść raportu zastępując ją wpisem "truncated". Może być stosowana do zmniejszenia objętości bazy danych. Działa tylko dla raportów w stanie gotowy (R) lub zablokowany (L). Stan flagi poprawności generacji może byc dowolny.

Parameters:

reportId - id raportu do obcięcia

Throws:

palio.PalioException

truncateReportCompressedContent

public void truncateReportCompressedContent(java.lang.Long reportId)
                                     throws palio.PalioException

Usuwa skompresowaną treść raportu zastępując ją wpisem "truncated". Może być stosowana do zmniejszenia objętości bazy danych. Działa tylko dla raportów w stanie gotowy (R) lub zablokowany (L) z dostepną zawartością skompresowaną.

Parameters:

reportId - id raportu do obcięcia

Throws:

palio.PalioException

reportURL

public java.lang.String reportURL(java.lang.Long reportId)
                           throws palio.PalioException

Zwraca URL do raportu o podanym id.

Parameters:

reportId - id raportu do którego ma zostać wygenerowany URL

Returns:

URL do raportu o podanym id

Throws:

palio.PalioException

compressedReportURL

public java.lang.String compressedReportURL(java.lang.Long reportId)
                                     throws palio.PalioException

Zwraca URL do raportu o podanym id w wersji skompresowanej. Funkcja nie sprawdza, czy skompresowana treść jest dostępna.

Parameters:

reportId - id raportu do którego ma zostać wygenerowany URL

Returns:

URL do raportu o podanym id

Throws:

palio.PalioException

getFormattedFileSize

public java.lang.String getFormattedFileSize(java.lang.Long fileSize,
                                             java.lang.String separator,
                                             java.lang.Long fractionDigits)
                                      throws palio.PalioException

Zwraca podany w B rozmiar pliku w odpowiednich jednostkach (B, kB, MB, itd), 1kB=1024B, 1MB=1024kB itd. Pomiędzy wielkość a jednostki wstawiany jest podany separator, jeśli null to nic nie jest wstawiane.

Parameters:

fileSize - id raportu do którego ma zostać wygenerowany URL

separator - ciąg wstawiany pomiędzy wielkość pliku a jednostki.

fractionDigits - ile jest zwracanych cyfr części ułamkowej wielkości pliku, podanie null oznacza 0 cyfr

Returns:

rozmiar pliku w odpowiednich jednostkach

Throws:

palio.PalioException

createOrReplaceHtmlInterface

public java.lang.String createOrReplaceHtmlInterface()
                                              throws palio.PalioException

Tworzy interfejs HTML (zestaw obiektów palio z tym interfejsem) do zarządzania, zlecania i pobierania raportów. Aby było możliwe korzystanie z interfejsu, należy dodać linki do stron wybranych spośród: report_module.categories, report_module.types, report_module.orders, report_module.waiting, report_module.cancelled, report_module.all, report_module.by_types, report_module.by_categories. Jeżeli strony istniały wcześniej, ich znacznik chroniona/nie oraz skojarzenia z przywilejami nie są modyfikowane.
Funkcja dodaje także referencyjny zestaw obiektów paliowych (przykładowe wykorzystanie modułu report i interfejsu).
Uwaga! Jeżeli w istniejących już obiektach tego interfejsu użytkownik wprowadził zmiany, to użycie tej funkcji nadpisze takie zmiany!

Returns:

status - "ok", "no control.txt", "no file aaa.txt bbb.txt ..."

Throws:

palio.PalioException