W celu zapoznania się z dokumentacją programu należy pobrać folder Dokumentacja, a następnie otworzyć poszczególne pliki za pomocą domyślnej przeglądarki. W każdym pliku znajduje się dokumetacja, w której opisane są klasy, jak również zawarte w nich metody wraz z parametrami oraz zwracanymmi wartościami. Plik ContentsMerged.css służy do modyfikowania stylu dokumentacji w przeglądarce.

Poniżej przedstawiony został diagram UML Biura_nieruchomości. Klasy oznaczone kolorem niebieskim są klasami abstrakcyjnymi.

Model zaprojektowany został w myśl zasad OOP, opierając się na mechanizmach kompozycji, dziedziczenia i agregacji. Ponadto zaimplementowane zostały również interfejsy, takie jak IOferuje, a także IComparable, IEquatable.

Wśród innych zasad Object Oriented Programming, które stanowiły podstawę tworzenia diagramu, można wymienić:

• hermetyzacja
• abstrakcja
• polimorfizm
• dziedziczenie
• Liskov substitution principle (klasa dziedzicząca pwoinna być dobrym odpowiednikiem klasy bazowej)
• KISS

Powyższa aplikacja została stworzona w celu obsługi biura nieruchomości.

• Dodawanie oraz usuwanie klienta z bazy
• Dodawanie oraz usuwanie nieruchomości z bazy wraz z jej specyfikacjami
• Dodawanie oraz usuwanie pracowników z bazy
• Dodawanie oferty wraz z jej opisem
• Wyszukiwanie nieruchomości w bazie na podstawie wybranych przez użytkownika filtrów. Mozliwosc wyswietlenia szczegolow danej nieruchomosci.
• Wyszukiwanie zarówno aktywnych jak i zarchiwizowanych ofert w bazie na podstawie wybranych przez użytkownika filtrów
• Wyszukiwanie pracowników w bazie wraz z opcjami sortowania po nazwisku lub po miejscowości
• Tworzenie umowy pośrednictwa sprzedaży oraz umowy pośrednictwa kupna wraz z możliwością ustawienia prowizji oraz przypisania klienta jak i opiekuna klienta (pracownika)
• Ustalanie prowizji od danej umowy dla biura nieruchomości
• Automatyczne sprawdzanie dostępności klienta w bazie na podstawie numeru PESEL

Po otwarciu aplikacji wyświetla się interfejs użytkownika, za pomocą którego dokonać można wszystkich wspomnianych powyżej operacji. Należy pamietać, by na początku wprowadzić do bazy dane klienta, pracownika oraz nieruchomości, ponieważ funkcjonalności takie jak tworzenie ofert czy umów opierają się właśnie na tych trzech podstawowych fundamentach modelu. Aplikacja została zaprojektowana w sposób intuicyjny, z troską o zapewnienie wygodnego produktu do obsługi podstawowej działalności biura nieruchomości

SKŁAD ZESPOŁU

• Majka Miezianko

• Klaudia Pajor

• Milena Pawlikiewicz

• Anna Pietryka

Po stworzeniu dokładnego konspektu programu, najrozsądniejszym wydawało się podzielenie pracy na etapy takie, by możliwie najczęściej weryfikować poprawność utworzonych już części kodu – co pozwoliło budować program od części najprostszych do tych najbardziej złożonych bez ryzyka wystąpienia skomplikowanych błędów pod koniec pracy, a przy tym na bieżąco dostosowywać program do ostatecznej wizji projektu.

By to osiągnąć, pracowano w grupach maksymalnie dwuosobowych synchronicznie, implementując partie kodu dotyczące analogicznych aspektów programu. Następnie na wspólny chat utworzony na portalu społecznościowym przekazywano podsumowanie wykonanej pracy, w ten sposób dostarczając pozostałym osobom informacje o bieżących zmianach, dzięki czemu bez zbędnej utraty czasu na zgłębianie najnowszych aktualizacji mogły przejść do wykonywania swojej części pracy.

Do synchronicznej pracy użyty został system kontroli wersji Git oraz hostingowy serwis internetowy GitHub.

Podział obowiązków

Projekt klas: Klaudia Pajor, Majka Miezianko, Anna Pietryka

Raport oraz opis projektu: Klaudia Pajor, Majka Miezianko

Projekt UML: Majka Miezianko

Interfejs

IOferuje: Majka Miezianko

Klasy

Klienci : Milena Pawlikiewicz, Majka Miezianko, Anna Pietryka, Klaudia Pajor

Klient : Milena Pawlikiewicz, Nieruchomosc, Klaudia Pajor, Anna Pietryka

Oferta : Milena Pawlikiewicz, Anna Pietryka, OfertyRazem, Anna Pietryka, Majka Miezianko

Osoba : Milena Pawlikiewicz, Majka Miezianko

Pracownicy : Milena Pawlikiewicz, Anna Pietryka

Pracownik : Milena Pawlikiewicz

Umowa : Milena Pawlikiewicz

UmowaPosrednictwaKupna : Milena Pawlikiewicz

UmowaPosrednictwaSprzedazy : Milena Pawlikiewicz

UmowyKupna : Milena Pawlikiewicz, Anna Pietryka, Klaudia Pajor

UmowySprzedazy : Milena Pawlikiewicz, Anna Pietryka, Klaudia Pajor

WszystkieNieruchomosci : Anna Pietryka, Klaudia Pajor

Okna

MainWindow : Klaudia Pajor

OknoDodajKlienta : Klaudia Pajor

OknoDodajNieruchomosc : Klaudia Pajor, Anna Pietryka

OknoDodajOferte : Klaudia Pajor, Majka Miezianko

OknoDodajPracownika : Klaudia Pajor

OknoListaKlientow : Klaudia Pajor

OknoListaNieruchomosci : Anna Pietryka, Klaudia Pajor

OknoListaPracownikow : Klaudia Pajor

OknoListaUmow : Klaudia Pajor, Anna Pietryka

OknoOferty : Majka Miezianko, Klaudia Pajor, Anna Pietryka

OknoSzczegolyNieruchomosci : Anna Pietryka, Klaudia Pajor

OknoSzczegolyOfert : Klaudia Pajor

OknoUmowaKupna : Klaudia Pajor

OknoUmowaSprzedazy : Klaudia Pajor

OknoUtworzNowaUmowe : Klaudia Pajor

UnitTests : Majka Miezianko

Dokumentacja : Majka Miezianko

Eksport dokumentacji do HTML: Majka Miezianko