Package com.suncode.pwfl.workflow.activity

Interface ActivityService

public interface ActivityService
Umożliwia zarządzanie zadaniami.
Author:
Paweł Rosolak 04-10-2012

  • Method Details

    • openActivity

      void openActivity(String userName, String processId, String activityId) throws UserIsNotAssignedToActivityException, ActivityAlreadyCompletedException, ActivityIsSuspendedException
      Uruchamia zadanie jako podany użytkownik. Po zakończeniu funkcji, zadanie zmienia status na uruchomione.
      Parameters:
      userName - Login użytkownika, którym chcemy uruchomić zadanie
      processId - Id procesu
      activityId - Id zadania
      Throws:
      UserIsNotAssignedToActivityException
      ActivityAlreadyCompletedException
      ActivityIsSuspendedException

    • openActivity

      @Deprecated(since="4.2") void openActivity(String userName, String userPassword, String processId, String activityId) throws UserIsNotAssignedToActivityException, ActivityAlreadyCompletedException, ActivityIsSuspendedException
      Deprecated.
      User password is not required anymore. Use openActivity(String, String, String) instead.
      Uruchamia zadanie jako podany użytkownik. Po zakończeniu funkcji, zadanie zmienia status na uruchomione.
      Parameters:
      userName - Login użytkownika, którym chcemy uruchomić zadanie
      userPassword - Hasło użytkownika
      processId - Id procesu
      activityId - Id zadania
      Throws:
      UserIsNotAssignedToActivityException
      ActivityAlreadyCompletedException
      ActivityIsSuspendedException

    • openActivity

      @Deprecated(since="4.2") void openActivity(String domain, String userName, String userPassword, String processId, String activityId) throws Exception
      Deprecated.
      Domain and user password is not required anymore. Use openActivity(String, String, String) instead.
      Uruchamia zadanie jako podany użytkownik. Po zakończeniu funkcji, zadanie zmienia status na uruchomione.
      Parameters:
      domain - Domena użytkownika
      userName - Login użytkownika, którym chcemy uruchomić zadanie
      userPassword - Hasło użytkownika
      processId - Id procesu
      activityId - Id zadania
      Throws:
      Exception

    • setActivityContext

      void setActivityContext(String processId, String activityId, Map<String,Object> activityContext)
      Ustawia mapę zmiennych zadania
      Parameters:
      processId - Id procesu
      activityId - Id zadania
      activityContext - Mapa zmiennych zadania

    • getActivityContext

      Map<String,Object> getActivityContext(String processId, String activityId)
      Metoda służy do pobierania kontekst mapy zadania(zawiera wszystkie zmienne i ich wartości z zadania)
      Parameters:
      processId - Id procesu
      activityId - Id zadania
      Returns:
      Zwaraca mapę zmiennych zadania

    • getActivity

      Activity getActivity(String processId, String activityId, String... joins)
      Pobiera informacje o zadaniu
      Parameters:
      processId - Id procesu
      activityId - Id zadania
      joins - Określa, które elementy mamy dołączyć do obiektu zadania.
      Returns:
      Zwraca informacje o zadaniu

    • getActivityDelegation

      DelegatedActivity getActivityDelegation(String activityId, String userName)
      Pobiera informacje o zastępstwie
      Parameters:
      activityId - Id zadania
      userName - Użytkownik, który zastępuje pierwotnego użytkownika
      Returns:
      Zwraca null jeżeli podany użytkownik nie jest zastępcą w tym zadaniu

    • getActivityDelegations

      List<DelegatedActivity> getActivityDelegations(String activityId, String userName)
      Zwraca informacje o wszystkich zastępstwach
      Parameters:
      activityId - Id zadania
      userName - Użytkownik, który zastępuje pierwotnego użytkownika
      Returns:
      Zwraca null jeżeli podany użytkownik nie jest zastępcą w tym zadaniu

    • getActivityDelegations

      List<DelegatedActivity> getActivityDelegations(String activityId)
      Zwraca informacje o wszystkich zastępstwach dla danego zadania
      Parameters:
      activityId - Id zadania
      Returns:
      Zwraca listę zastępstw dla zadania

    • addActivityDelegation

      void addActivityDelegation(DelegatedActivity da)
      Dodaje zastępstwo
      Parameters:
      da - Definicja zastępstwa

    • deleteActivityDelegation

      void deleteActivityDelegation(DelegatedActivity da)
      Dodaje zastępstwo
      Parameters:
      da - Definicja zastępstwa

    • acceptActivity

      void acceptActivity(AcceptationDefinition definition)
      Akceptuje zadanie. Użytkownik nie musi mieć zadania przypisanego do siebie, jeżeli parametr ignoreOwnerShip w definicji jest ustawiony na true.
      Parameters:
      definition - Definicja akceptacji zadania

    • getAssignments

      List<String> getAssignments(String processId, String activityId)
      Pobiera informacje o przypisanych do zadania użytkownikach
      Parameters:
      activityId - Id zadania
      Returns:
      Zwraca listę loginów użytkowników przypisanych do zadania

    • getActivityName

      String getActivityName(String processDefId, String activityDefId)

    • changeState

      void changeState(String processId, String activityId, ActivityState state)
      Zmienia status zadania
      Parameters:
      processId - Id procesu
      activityId - Id zadania
      state - Status zadania, który chcemy ustawić

    • changeStateIfPossible

      boolean changeStateIfPossible(String processId, String activityId, ActivityState state)
      Zmienia status zadania, jeżeli obecny status można zmienić na nowy. W odróżnieniu do {changeState(String, String, ActivityState) jeżeli nie można zmienić statusu z powodu niekompatybilnego obecnego statusu zadania, nie zostanie rzucony żaden wyjątek. Jedynie w logach będzie informacja, że nie można mienić statusu takiego zadania.
      Parameters:
      processId - Id procesu
      activityId - Id zadania
      state - Status zadania, który chcemy ustawić
      Returns:
      true - jeżeli status został zmieniony, false - jeżeli nie udało się zmienić statusu.
      Throws:
      ServiceException - Wyjątek rzucony w przypadku nieoczekiwanego błędu.

    • abort

      void abort(String processId, String activityId)
      Anuluje zadanie. W przypadku, kiedy jest to ostatnie otwarte zadanie w procesie, anuluje też cały proces.
      Parameters:
      processId - Id procesu
      activityId - Id zadania

    • deleteActivities

      void deleteActivities(List<Activity> activities)
      Usuwa zadania
      Parameters:
      activities - Lista obiektów zadania

    • suspendActivity

      void suspendActivity(String activityId, String processId) throws ActivityAlreadyCompletedException
      Zawiesza zadanie.
      Parameters:
      activityId - Id zadania
      processId - Id procesu
      Throws:
      ActivityAlreadyCompletedException - Wyjątek rzucony w przypadku gdy zadanie nie może zostać zawieszone

    • suspendActivity

      void suspendActivity(String activityId, String processId, boolean group) throws ActivityAlreadyCompletedException
      Zawiesza zadanie.
      Parameters:
      activityId - Id zadania
      processId - Id procesu
      group - czy operacja grupowa
      Throws:
      ActivityAlreadyCompletedException - Wyjątek rzucony w przypadku gdy zadanie nie może zostać zawieszone

    • resumeActivity

      void resumeActivity(String activityId, String processId) throws ActivityIsNotSuspendedException
      Przywraca zadanie.
      Parameters:
      activityId - Id zadania
      processId - Id procesu
      Throws:
      ActivityIsNotSuspendedException - Wyjątek rzucony w przypadku gdy zadanie nie jest zawieszone

    • resumeActivity

      void resumeActivity(String activityId, String processId, boolean group) throws ActivityIsNotSuspendedException
      Przywraca zadanie.
      Parameters:
      activityId - Id zadania
      processId - Id procesu
      group - czy operacja grupowa
      Throws:
      ActivityIsNotSuspendedException - Wyjątek rzucony w przypadku gdy zadanie nie jest zawieszone

    • getOpenActivitiesForProcess

      List<Activity> getOpenActivitiesForProcess(String processId)
      Pobiera wszystkie otwarte zadania dla danego procesu.
      Parameters:
      processId - Id procesu

    • getOpenActivitiesAssignedToUser

      @Beta CountedResult<UserActivity> getOpenActivitiesAssignedToUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane otwarte zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getNewActivitiesAssignedToUser

      @Beta CountedResult<UserActivity> getNewActivitiesAssignedToUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane nowe zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getRunningActivitiesAssignedToUser

      @Beta CountedResult<UserActivity> getRunningActivitiesAssignedToUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane uruchomione zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getWaitingToStartActivitiesAssignedToUser

      @Beta CountedResult<UserActivity> getWaitingToStartActivitiesAssignedToUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane oczekujące na uruchomienie zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getActivitiesInSubstitutionAssignedToUser

      @Beta CountedResult<UserActivity> getActivitiesInSubstitutionAssignedToUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane zadania w zastępstwie danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getOpenActivitiesWithExceededDeadlineAssignedToUser

      @Beta CountedResult<UserActivity> getOpenActivitiesWithExceededDeadlineAssignedToUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane przeterminowane zadania danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getAllFinishedActivitiesForUser

      @Beta CountedResult<FinishedUserActivity> getAllFinishedActivitiesForUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane wykonane zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getFailedFinishedActivitiesForUser

      @Beta CountedResult<FinishedUserActivity> getFailedFinishedActivitiesForUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane błędne wykonane zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getSuccessfulFinishedActivitiesForUser

      @Beta CountedResult<FinishedUserActivity> getSuccessfulFinishedActivitiesForUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane poprawne wykonane zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getProcessingFinishedActivitiesForUser

      @Beta CountedResult<FinishedUserActivity> getProcessingFinishedActivitiesForUser(String userName, List<String> processDefinitionIds, Integer start, Integer limit, String sortBy, SortDirection sortDirection)
      Pobiera stronnicowane przetwarzane wykonane zadania dla danego użytkownika, należące do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)
      start - Przesunięcie w zbiorze wynikowym
      limit - Maksymalna liczba zwróconych wyników
      sortBy - Określa pole, po którym ma nastąpić sortowanie
      sortDirection - Określa kierunek sortowania

    • getProcessDefIdsForOpenActivitiesAssignedToUser

      @Beta List<String> getProcessDefIdsForOpenActivitiesAssignedToUser(String userName)
      Pobiera listę id definicji procesów otwartych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForNewActivitiesAssignedToUser

      @Beta List<String> getProcessDefIdsForNewActivitiesAssignedToUser(String userName)
      Pobiera listę id definicji procesów nowych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForRunningActivitiesAssignedToUser

      @Beta List<String> getProcessDefIdsForRunningActivitiesAssignedToUser(String userName)
      Pobiera listę id definicji procesów uruchomionych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForWaitingToStartActivitiesAssignedToUser

      @Beta List<String> getProcessDefIdsForWaitingToStartActivitiesAssignedToUser(String userName)
      Pobiera listę id definicji procesów oczekujących na uruchomienie zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForActivitiesInSubstitutionAssignedToUser

      @Beta List<String> getProcessDefIdsForActivitiesInSubstitutionAssignedToUser(String userName)
      Pobiera listę id definicji procesów zadań w zastępstwie dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForActivitiesWithExceededDeadlineAssignedToUser

      @Beta List<String> getProcessDefIdsForActivitiesWithExceededDeadlineAssignedToUser(String userName)
      Pobiera listę id definicji procesów przeterminowanych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForAllFinishedActivities

      @Beta List<String> getProcessDefIdsForAllFinishedActivities(String userName)
      Pobiera listę id definicji procesów wykonanych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForFailedFinishedActivities

      @Beta List<String> getProcessDefIdsForFailedFinishedActivities(String userName)
      Pobiera listę id definicji procesów błędnych wykonanych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForSuccessfulFinishedActivities

      @Beta List<String> getProcessDefIdsForSuccessfulFinishedActivities(String userName)
      Pobiera listę id definicji procesów poprawnych wykonanych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • getProcessDefIdsForProcessingFinishedActivities

      @Beta List<String> getProcessDefIdsForProcessingFinishedActivities(String userName)
      Pobiera listę id definicji procesów przetwarzanych wykonanych zadań dla danego użytkownika.
      Parameters:
      userName - Nazwa użytkownika
      Returns:

    • countOpenActivitiesAssignedToUser

      @Beta long countOpenActivitiesAssignedToUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę otwartych zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countNewActivitiesAssignedToUser

      @Beta long countNewActivitiesAssignedToUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę nowych zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countRunningActivitiesAssignedToUser

      @Beta long countRunningActivitiesAssignedToUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę uruchomionych zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countWaitingToStartActivitiesAssignedToUser

      @Beta long countWaitingToStartActivitiesAssignedToUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę oczekujących na uruchomienie zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countActivitiesInSubstitutionAssignedToUser

      @Beta long countActivitiesInSubstitutionAssignedToUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę zadań w zastępstwie danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countOpenActivitiesWithExceededDeadlineAssignedToUser

      @Beta long countOpenActivitiesWithExceededDeadlineAssignedToUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę przeterminowanych zadań danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countAllFinishedActivitiesForUser

      @Beta long countAllFinishedActivitiesForUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę wykonanych zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countFailedFinishedActivitiesForUser

      @Beta long countFailedFinishedActivitiesForUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę błędnie wykonanych zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countSuccessfulFinishedActivitiesForUser

      @Beta long countSuccessfulFinishedActivitiesForUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę poprawnie wykonanych zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)

    • countProcessingFinishedActivitiesForUser

      @Beta long countProcessingFinishedActivitiesForUser(String userName, List<String> processDefinitionIds)
      Pobiera liczbę przetwarzanych wykonanych zadań dla danego użytkownika, należących do podanych typów procesów.
      Parameters:
      userName - Nazwa użytkownika
      processDefinitionIds - Lista id definicji procesów, do których mogą należeć otwarte zadania (pusta lista/null = wszystkie definicje procesów)