Page History

Spis treści

Wstęp

API Systemu PlusWorkflow udostępnia zbiór interfejsów i klas umożliwiających wykonywanie operacji systemowych. Najważniejszymi elementami API są usługi (Service) i klasy wyszukujące (Finder). Dostęp do tych elementów uzyskujemy poprzez klasy ServiceFactory oraz FinderFactory. Przykłady:

UserService us=ServiceFactory.getUserService();
ActivityService as=ServiceFactory.getActivityService();

UserFinder uf=FinderFactory.getUserFinder();
PositionFinder pf=FinderFactory.getPositionFinder();

Gdy mamy stworzoną instancję klasy Service możemy wykonywać dowolne operacje. Lista dostępnych serwisów:

1. UserService - zarządzanie użytkownikami, oraz grupami użytkowników
2. StructureService - zarządzanie stanowiskami, jednostkami organizacyjnymi,
3. RoleService -zarządzanie rolami,
4. UserSettingsService - zarządzanie ustawieniami użytkowników
5. ArchiveStorageService - zarządzanie strukturą archiwum ( urządzenia, katalogi )
6. DocumentClassSerivce - zarządzanie klasami dokumentów
7. DocumentService - zarządzanie dokumentami archiwum systemowego
8. FileService - zarządzanie plikami systemu
   
9. ActivityService - zarządzanie zadaniami
10. ProcessService - zarządzanie procesami
11. FormService - odczyt informacji dotyczących formularza procesów
12. CommentService - zarządzanie komentarzami procesów
13. CustomService - zarządzanie własnymi obiektami bazodanowymi
14. DocumentTemplateService - zarządzanie szablonami dokumentów dla procesów

Lista dostępnych interfejsów wyszukujących:

1. UserFinder - wyszukiwanie użytkowników
2. UserGroupFinder - wyszukiwanie grup użytkowników
3. DocumentFinder - wyszukiwanie dokumentów
4. ProcessFinder - wyszukiwanie procesów
5. ActivityFinder - wyszukiwanie zadań
6. PositionFinder - wyszukiwanie stanowisk
7. OrganizationalUnitFinder - wyszukiwanie jednostek organizacyjnych
   
8. RoleFinder - wyszukiwanie ról

Przykłady użycia usług

 		UserService us=ServiceFactory.getUserService(); 
        User user = new User("jkowalski","haslo");
        user.setFirstName("Jan");
        user.setLastName("Kowalski");
        us.createUser( user , "Pracownicy");

UserService us=ServiceFactory.getUserService(); 
User user = us.getUser("jkowalski");

Pobieranie powiązanych obiektów

Większość obiektów w systemie ma powiązania z innymi obiektami. Powiązania te obrazują schemat bazy danych. W większości przypadków obiekt podstawowy np. User, Position itd., znajduje się w osobnej tabeli bazy danych dlatego obiekty powiązane nie są domyślnie pobierane, aby zminimalizować czas wykonywania zapytania. Aby umożliwić pobieranie obiektów powiązanych metody służące do pobierania danych tj. get(), getAll(),getBy,,,() są wyposażone w parametr 'joins', określający które elementy mają zostać dołączone do pobieranego obiektu. Każda klasa podstawowa ma zdefiniowane stałe statyczne, których możemy użyć jako wartości parametru 'joins'. Argument  'joins' możemy ustawiać przekazując do funkcji tablicę lub listę wartości oddzielonych przecinkiem (parametr jest typu String). Przykłady:

User user = service.getUser( "jkowalski", User.JOIN_GROUPS );
for ( UserGroup ug : user.getGroups() )
{
   log.debug( ug.getName() );
}

User user = service.getUser( "jkowalski", User.JOIN_GROUPS, User.JOIN_POSITIONS, User.JOIN_OU );
Set<UserGroup> groups=user.getGroups();
Set<Position> positions=user.getPositions();
for ( Position position : positions )
{
   log.debug( position.getOrganizationalUnit().getName() );
}
 

Jak widać na powyższym przykładzie możemy pobierać obiekty powiązane pośrednio. W przykładzie pobieramy stanowiska użytkownika i dla każdego stanowiska pobieramy również jednostkę organizacyjną.

User user = service.getByUserId( "jkowalski", "positions", "positions.organizationalUnit", "positions.organizationalUnit.directorPosition","positions.organizationalUnit.directorPosition.roles" );

  for ( Position p : user.getPositions() )
            {
                if ( p.getOrganizationalUnit() != null )
                {
                    if ( p.getOrganizationalUnit().getDirectorPosition() != null )
                    {
                        for ( PositionRole pr : p.getOrganizationalUnit().getDirectorPosition().getRoles() )
                        {
                            log.debug( pr.getRoleId() );
                        }
                    }
                }
            }