palio.modules
Class Scheduler

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

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class Scheduler
extends Module

Moduł umożliwia planowanie zadań wykonywanych przez jPalio. Zadania definiuje się w obiektach. Zalecane jest aby wszelkie operacje na planowanych zadaniach (deaktywowanie, usuwanie) wykonywane były przy użyciu metod tego modułu.
Możliwe jest tworzenie grup zadań. Każda grupa zadań jest obsługiwana przez odzielny wątek.

Moduł trzeba dodać w konfiguracji instancji jPalio.

Version:

2.1.2

Author:

Krzysztof Madyniak (kmadyniak@torn.com.pl), Krzysztof Synowiec (ksynowiec@torn.com.pl), Radoslaw Osinski (radoslaw.osinski@torn.com.pl)

Nested Class Summary

class

Scheduler.PalioTask

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

Scheduler(Instance instance, java.util.Properties parameters)

Method Summary

Scheduler.PalioTask	_getTask(java.lang.Long taskID)
java.lang.Long	addTask(java.lang.Long objectID, java.util.Date startDate, java.lang.Long period, java.lang.Long priority, java.lang.String name, java.lang.String description, java.lang.Long groupID, java.lang.Boolean isActive) Dodaje nowe zadanie
java.lang.Long	addTask(java.lang.Long objectID, java.util.Date startDate, java.lang.Long period, java.lang.String name, java.lang.String description)
java.lang.Long	addTask(java.lang.Long objectID, java.util.Date startDate, java.lang.Long period, java.lang.String name, java.lang.String description, java.lang.Boolean isActive)
java.lang.Long	addTask(java.lang.Long objectID, java.util.Date startDate, java.lang.Long period, java.lang.String name, java.lang.String description, java.lang.Long groupID, java.lang.Boolean isActive) Dodaje nowe zadanie
java.lang.Long	addTask(java.lang.Long objectID, java.lang.Long year, java.lang.Long month, java.lang.Long day, java.lang.Long hour, java.lang.Long minute, java.lang.Long second, java.lang.Long period, java.lang.String name, java.lang.String description) Dodaje nowe zadanie
java.lang.Object[]	getTask(java.lang.Long taskID) Deprecated. Replaced by getTask(String).
java.lang.Object[]	getTask(java.lang.String taskName) Zwraca parametry zadania o podanej nazwie
java.lang.Long	getTaskIdByName(java.lang.String taskName) Zwraca id zadania o podanej nazwie
java.lang.Long	getTaskObject(java.lang.Long taskID)
java.lang.Long	getTaskPriority(java.lang.Long taskID) Pobiera priorytet zadania (1-9, domyślnie "null" oznacza 5)
java.lang.String	getTaskRunningState(java.lang.Long taskID) Pokazuje stan wykonywanego zadania.
java.util.LinkedList	getTasks() Zwraca listę wszystkich zaplanowanych zadań
java.lang.String	getVersion() Zwraca numer wersji modułu
void	interruptTask(java.lang.Long taskID) Przerywa wykonywanie danego zadania
boolean	isTaskActive(java.lang.Long taskID)
void	removeTask(java.lang.Long taskID) Usuwa zaplanowane zadanie o podanym id
void	scheduleTasks()
void	setTaskActive(java.lang.Long taskID, java.lang.Boolean status) Ustawia status zadania o podanym id
void	setTaskDescription(java.lang.Long taskID, java.lang.String description) Przypisuje opis do zadania o podanym id
void	setTaskName(java.lang.Long taskID, java.lang.String name) Przypisuje nazwę do zadania o podanym id
void	setTaskObject(java.lang.Long taskID, java.lang.Long objectID) Przypisuje obiekt palio do zadania o podanym id
void	setTaskPeriod(java.lang.Long taskID, java.lang.Long period)
void	setTaskPriority(java.lang.Long taskID, java.lang.Long priority) Ustawia priorytet zadania.
void	setTaskStartDate(java.lang.Long taskID, java.util.Date startDate)

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

Scheduler

public Scheduler(Instance instance,
                 java.util.Properties parameters)

Method Detail

scheduleTasks

public void scheduleTasks()

getVersion

public java.lang.String getVersion()

Zwraca numer wersji modułu

Specified by:

getVersion in class Module

addTask

public java.lang.Long addTask(java.lang.Long objectID,
                              java.lang.Long year,
                              java.lang.Long month,
                              java.lang.Long day,
                              java.lang.Long hour,
                              java.lang.Long minute,
                              java.lang.Long second,
                              java.lang.Long period,
                              java.lang.String name,
                              java.lang.String description)
                       throws palio.PalioException

Dodaje nowe zadanie

Parameters:

objectID - id obiektu palio wykonywanego przez zadanie

year - rok z daty startu zadania (format yyyy)

month - miesiąc z daty startu zadania

day - dzień miesiąca z daty startu zadania

hour - godzina z daty startu zadania

minute - minuta z daty startu zadania

second - sekunda z daty startu zadania

period - okres czasu co jaki ma się wykonywać zadanie (w milisekundach)

name - nazwa zadania

description - opis zadania

Throws:

palio.PalioException

addTask

public java.lang.Long addTask(java.lang.Long objectID,
                              java.util.Date startDate,
                              java.lang.Long period,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.Long groupID,
                              java.lang.Boolean isActive)
                       throws palio.PalioException

Dodaje nowe zadanie

Parameters:

objectID - id obiektu palio wykonywanego przez zadanie

startDate - data startu zadania

period - okres czasu co jaki ma się wykonywać zadanie (w milisekundach)

name - nazwa zadania

description - opis zadania

groupID - identyfikator grupy zadań do której ma zostac dodane zadanie

isActive - czy zadanie ma byc aktywne

Throws:

palio.PalioException

addTask

public java.lang.Long addTask(java.lang.Long objectID,
                              java.util.Date startDate,
                              java.lang.Long period,
                              java.lang.Long priority,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.Long groupID,
                              java.lang.Boolean isActive)
                       throws palio.PalioException

Dodaje nowe zadanie

Parameters:

objectID - id obiektu palio wykonywanego przez zadanie

startDate - data startu zadania

period - okres czasu co jaki ma się wykonywać zadanie (w milisekundach)

priority - prioryten (1-9, domyślnie "null" oznacza 5)

name - nazwa zadania

description - opis zadania

groupID - identyfikator grupy zadań do której ma zostac dodane zadanie

isActive - czy zadanie ma byc aktywne

Throws:

palio.PalioException

Since:

module 2.1.0

addTask

public java.lang.Long addTask(java.lang.Long objectID,
                              java.util.Date startDate,
                              java.lang.Long period,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.Boolean isActive)
                       throws palio.PalioException

Throws:

palio.PalioException

addTask

public java.lang.Long addTask(java.lang.Long objectID,
                              java.util.Date startDate,
                              java.lang.Long period,
                              java.lang.String name,
                              java.lang.String description)
                       throws palio.PalioException

Throws:

palio.PalioException

getTasks

public java.util.LinkedList getTasks()
                              throws palio.PalioException

Zwraca listę wszystkich zaplanowanych zadań

Returns:

lista zaplanowanych zadań Każdy wiersz reprezentujacy zadanie składa się z tablicy elementów:

• nr 0 - ID zadania
• nr 1 - nazwa zadania
• nr 2 - opis zadania
• nr 3 - (Date) data startu zadania
• nr 4 - okres czasu co jaki ma wykonywać się zadanie
• nr 5 - id obiektu wywyoływanego przez zadanie
• nr 6 - status zadania ("Y" - aktywne, "N" - nieaktywne)
• nr 7 - id grupy zadań
• nr 8 - priorytet zadania (1-9, domyślnie "null" oznacza 5)

Throws:

palio.PalioException

getTask

@Deprecated
public java.lang.Object[] getTask(java.lang.Long taskID)
                           throws palio.PalioException

Deprecated. Replaced by getTask(String).

Zwraca parametry zadania o podanym id

Parameters:

taskID - id zadania

Returns:

tablica elementów reprezentuj?cych zadanie Tablica elementów:

• nr 0 - id zadania
• nr 1 - nazwa zadania
• nr 2 - opis zadania
• nr 3 - (Date) data startu zadania
• nr 4 - okres czasu co jaki ma wykonywać się zadanie
• nr 5 - id obiektu wywyoływanego przez zadanie
• nr 6 - status zadania ("Y" - aktywne, "N" - nieaktywne)
• nr 7 - id grupy zadań
• nr 8 - priorytet zadania (1-9, domyślnie "null" oznacza 5)

Throws:

palio.PalioException

getTask

public java.lang.Object[] getTask(java.lang.String taskName)
                           throws palio.PalioException

Zwraca parametry zadania o podanej nazwie

Parameters:

taskName - nazwa zadania

Returns:

tablica elementów reprezentujacych zadanie lub null jeśli zadanie nie istnieje. Tablica elementów:

• nr 0 - id zadania
• nr 1 - nazwa zadania
• nr 2 - opis zadania
• nr 3 - (Date) data startu zadania
• nr 4 - okres czasu co jaki ma wykonywać się zadanie
• nr 5 - id obiektu wywyoływanego przez zadanie
• nr 6 - status zadania ("Y" - aktywne, "N" - nieaktywne)
• nr 7 - id grupy zadań
• nr 8 - priorytet zadania (1-9, domyślnie "null" oznacza 5)

Throws:

palio.PalioException

Since:

jPALIO 7.4.65, module 2.1.2

getTaskIdByName

public java.lang.Long getTaskIdByName(java.lang.String taskName)
                               throws palio.PalioException

Zwraca id zadania o podanej nazwie

Parameters:

taskName - nazwa zadania

Returns:

id zadania lub null jesli nie istnieje

Throws:

palio.PalioException

Since:

jPALIO 7.4.65, module 2.1.2

setTaskName

public void setTaskName(java.lang.Long taskID,
                        java.lang.String name)
                 throws palio.PalioException

Przypisuje nazwę do zadania o podanym id

Parameters:

taskID - id zadania

name - nazwa

Throws:

palio.PalioException

setTaskDescription

public void setTaskDescription(java.lang.Long taskID,
                               java.lang.String description)
                        throws palio.PalioException

Przypisuje opis do zadania o podanym id

Parameters:

taskID - id zadania

description - opis

Throws:

palio.PalioException

setTaskActive

public void setTaskActive(java.lang.Long taskID,
                          java.lang.Boolean status)
                   throws palio.PalioException

Ustawia status zadania o podanym id

Parameters:

taskID - id zadania

status - status zadania(true - aktywne, false - nieaktywne)

Throws:

palio.PalioException

setTaskObject

public void setTaskObject(java.lang.Long taskID,
                          java.lang.Long objectID)
                   throws palio.PalioException

Przypisuje obiekt palio do zadania o podanym id

Parameters:

taskID - id zadania

objectID - id obiektu palio

Throws:

palio.PalioException

setTaskPriority

public void setTaskPriority(java.lang.Long taskID,
                            java.lang.Long priority)
                     throws palio.PalioException

Ustawia priorytet zadania. Zmieniony zostaje priorytet aktualnie wykonywanego zadania iprzyszłych zadań.

Parameters:

taskID - id zadania

priority - priorytet zadania (1-9, domyślnie "null" oznacza 5)

Throws:

palio.PalioException

Since:

module 2.1.0

getTaskPriority

public java.lang.Long getTaskPriority(java.lang.Long taskID)
                               throws palio.PalioException

Pobiera priorytet zadania (1-9, domyślnie "null" oznacza 5)

Parameters:

taskID - id zadania

Throws:

palio.PalioException

Since:

module 2.1.0

removeTask

public void removeTask(java.lang.Long taskID)
                throws palio.PalioException

Usuwa zaplanowane zadanie o podanym id

Parameters:

taskID - id zadania

Throws:

palio.PalioException

getTaskObject

public java.lang.Long getTaskObject(java.lang.Long taskID)

isTaskActive

public boolean isTaskActive(java.lang.Long taskID)

setTaskStartDate

public void setTaskStartDate(java.lang.Long taskID,
                             java.util.Date startDate)
                      throws palio.PalioException

Throws:

palio.PalioException

setTaskPeriod

public void setTaskPeriod(java.lang.Long taskID,
                          java.lang.Long period)
                   throws palio.PalioException

Throws:

palio.PalioException

interruptTask

public void interruptTask(java.lang.Long taskID)

Przerywa wykonywanie danego zadania

Parameters:

taskID - id zadania

getTaskRunningState

public java.lang.String getTaskRunningState(java.lang.Long taskID)

Pokazuje stan wykonywanego zadania. Jeżeli zadanie nie jest aktualnie uruchomione, zostanie zwrócony null.

Parameters:

taskID - id zadania

_getTask

public Scheduler.PalioTask _getTask(java.lang.Long taskID)