Metody ¶
count - Policz ¶
/** * Metoda zwraca liczbę obiektów, które spełniają wszystkie (global_operator=AND) lub którekolwiek (global_operator=OR) kryterium wyszukiwania podane w tablicy field * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // obiekt modelu, który będzie wyszukany. Typ modelu będzie użyty w celu ustalenia jakie obiekty mają być zwrócone oraz gdzie będą wyszukiwane * @param fields // obiekt typu fields, zawierający informację o polach według których będzie przeprowadzone wyszukiwanie oraz czy wyszukiwanie ma spełniać wszystkie kryteria, czy wystarczy jedno * @return response // zwraca obiekt response, który w polu answer zawiera pojedynczą wartość int, oznaczającą liczbę objektów spełniających warunki. */ count ( (String) callerPN, (String) api_key, (Obj) model, (Obj) fields) |
search - Wyszukaj ¶
/** * Metoda zwraca listę identyfikatorów, które spełniają wszystkie (global_operator=AND) lub którekolwiek (global_operator=OR) kryterium wyszukiwania podane w tablicy field * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // obiekt modelu, który będzie wyszukany. Typ modelu będzie użyty w celu ustalenia jakie obiekty mają być zwrócone oraz gdzie będą wyszukiwane * @param fields // obiekt typu fields, zawierający informację o polach według których będzie przeprowadzone wyszukiwanie oraz czy wyszukiwanie ma spełniać wszystkie kryteria, czy wystarczy jedno * @param sort_order // tablica obiektów typu sort_order, zawierająca nazwy (referencje), pól oraz sposób posorotwania. Kolejność w tablicy jest kolejnością sortowania (0 - najwazniejsze kryterium) * @param return_params // objekt typu return_params, zawierający informację o pierwszym zwróconym elemencie, oraz ich ilości (np zwróć elementy od 10-20) * @return response // zwraca obiekt response, który w polu answer zawiera array int (id), jako tablicę identyfikatorów (int) do zasobów */ search( (String) callerPN, (String) api_key, (Obj) model, (Obj) fields, (Obj) Array sort_order, (Obj) return_params) |
searchAndGet - Wyszukaj i pobierz ¶
/** * Metoda zwraca listę obiektów, które spełniają wszystkie (global_operator=AND) lub którekolwiek (global_operator=OR) kryterium wyszukiwania podane w tablicy field * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // obiekt modelu, który będzie wyszukany. Typ modelu będzie użyty w celu ustalenia jakie obiekty mają być zwrócone oraz gdzie będą wyszukiwane, pola w obiekcie model posłużą do ustalenia co ma być zwrócone. Jeśli jakiekolwiek pole w obiekcie model będzie ustawione na NULL, to ta wartość nie zostanie zwrócona w wynikach w polu answer. Jeśli w będzie tam jakakolwiek inna wartość wynik ten zostanie zwrócony. Dla przykładu podajemy obiekt employee z polem name = NULL. Wszystkie wyniki pozbawione będą pola name (lub będzie ono równe NULL). * @param fields // obiekt typu fields, zawierający informację o polach według których będzie przeprowadzone wyszukiwanie oraz czy wyszukiwanie ma spełniać wszystkie kryteria, czy wystarczy jedno * @param sort_order // tablica obiektów typu sort_order, zawierająca nazwy (referencje), pól oraz sposób posorotwania. Kolejność w tablicy jest kolejnością sortowania (0 - najważniejsze kryterium) * @param return_params // objekt typu return_params, zawierający informację o pierwszym zwróconym elemencie, oraz ich ilości (np zwróć elementy od 10-20) * @return response // zwraca obiekt response, który w polu answer zawiera array int (id), jako tablicę identyfikatorów (int) do zasobów */ searchAndGet( (String) callerPN, (String) api_key, (Obj) model, (Obj) fields, (Obj) Array sort_order, (Obj) return_params) |
update - zaktualizuj ¶
/** * Metoda próbuje dokonać aktualizacji rekordu id, o nowe dane zapisane w obiekcie update_model * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // obiekt modelu, którego typ będzie wykorzystany * @param id // tablica identyfikatorów rekordów, które będą zaktualizowane * @param update_model // tablica obiektów typu model, które będą zaktualizowane. Tablica ta musi być albo równoliczna z tablicą id, lub zawierać tylko jeden element. W przypadku, gdy zawiera tylko jeden element, wszystkie rekordy modelu o identyfikatorze znajdującym się w tablicy id zostaną zaktualizowane tymi samymi wartościami (które znajdują się w update_model (przydatne, gdy np zmieniamy pojedynczą rzecz dużej liczby użytkowników)). Update_model jest to obiekt, zawierający pola modelu (ale nie musi posiadać wszystkich). Każde pole, które znajduje się w update_model będzie zaktualizowane w modelu, który został wybrany. W przypadku, gdy pole w update_model jest równe NULL, pole takie zostanie usunięte w rekordzie docelowym. Pola, które nie wystąpiły w update_model pozostaną niezmienione. * @return response // obiekt odpowiedzi, zawierający informację o sukcesie, lub komunikacie o błędzie. */ update( (String) callerPN, (String) api_key, (Obj) model, (Int) array id, (Obj) array update_model) |
insert - wstaw ¶
/** * Metoda próbuje dokonać aktualizacji rekordu id, o nowe dane zapisane w obiekcie update_model * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // obiekt modelu, którego typ będzie wykorzystany * @param insert_model // tablica obiektów typu model, które będą dodane do bazy modelu. Wartości id w obiekcie modelu zostaną zignorowane, ale ich obecność zwróci ostrzeżenie (warrning). * @return response // obiekt odpowiedzi, zawierający informację o sukcesie, lub komunikacie o błędzie */ insert( (String) callerPN, (String) api_key, (Obj) model, (Obj) array insert_model) |
delete - usuń ¶
/** * Metoda próbuje dokonać usunięcia rekordów o wartościach podanych w id * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // obiekt modelu, którego typ będzie wykorzystany * @param id // tablica identyfikatorów rekordów, które będą usunięte * @return response // obiekt odpowiedzi, zawierający informację o sukcesie, lub komunikacie o błędzie. Pole answer zawierać będzie listę usuniętych identyfikatorów rekordów w przypadku sukcesu oraz listę rekordów, których nie można było usunąć w przypadku błędu. */ delete ( (String) callerPN, (String) api_key, (Obj) model, (Int) array id ) |
getElementsById - pobierz elementy o id ¶
/** * Metoda zwraca tablicę obiektów typu model, dla wszystkich identyfikatorów w talibcy id. * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // obiekt modelu, który będzie wyszukany. Typ modelu będzie użyty w celu ustalenia jakie obiekty mają być zwrócone oraz gdzie będą wyszukiwane, pola w obiekcie model posłużą do ustalenia co ma być zwrócone. Jeśli jakiekolwiek pole w obiekcie model będzie ustawione na NULL, to ta wartość nie zostanie zwrócona w wynikach w polu answer. Jeśli w będzie tam jakakolwiek inna wartość wynik ten zostanie zwrócony. Dla przykładu podajemy obiekt employee z polem name = NULL. Wszystkie wyniki pozbawione będą pola name (lub będzie ono równe NULL). * @param id // tablica identyfikatorów do przekazania * @return response // obiekt odpowiedzi, zawierający informacje o sukcesie, w polu answer znajduje się tablica obiektów tablica objektów typu model, inna w zależności od wykorzystanego modelu */ getElementsById( (String) callerPN, (String) api_key, (Obj) model, (Int) Array id) |
getDistinctElementValues - pobierz wszystkie możliwe wartości pola ¶
/** * Metoda zwraca tablicę stringów zawierającą wszystkie różne wartości pola w bazie danych. Potrzebna do wypełniania np. list wyboru. * @param callerPN // personNumber osoby wywołującej metodę. Jeśli system nie może ustalić osoby, które wywołuję metodę, należy wstawić NULL * @param api_key // klucz aplikacji, na podstawie którego jest uwierzytelniona * @param model // nazwa modelu, który będzie wykorzystany * @param field_name // nazwa pola, które będzie sprawdzone * @return response // obiekt odpowiedzi, zawierający informacje o sukcesie, w polu answer znajduje się tablica wartości pola */ getDistinctElementValues( (String) callerPN, (String) api_key, (Obj) model, (String) field_name ) |