Package com.suncode.pwfl.archive.util
Class DocumentDefinition
java.lang.Object
com.suncode.pwfl.archive.util.DocumentDefinition
Obiek służący do defniowania specyficznych parametrów podczas dodawania dokumentu do archiwum
- Author:
- Paweł Rosolak 16 paź 2013
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionId zadania do którego chcemy dołączyć plik.Opis pliku.Id klasy dokumentów do której dodajemy plik.booleanOkreśla, czy przy próbie zapisu dokumentu jako nowa wersja uwzględniać indeksy niezdefiniowane w mapie indeksów (jako sprawdzenie "is null") a istniejące dla tej klasy dokumentów.Wyświetlana nazwa pliku.Indeksy dodawanago dokumentu.Strumień danych pliku.Parametr służy do przechowywania treści dokumentu zeskanowanego.Id procesu do którego chcemy dołączyć plik.Nazwa użytkownika, który dodaje plik.booleanbooleanOkreśla, czy zapisać plik jako nowa wersja(dodanie nowej wersji jest możliwe tylko, gdy dodawany dokument ma takie same indeksy jak istniejący już dokument w archiwum).voidsetActivityId(String activityId) Id zadania do którego chcemy dołączyć plik.voidsetAttachToClosedActivities(boolean attachToClosedActivities) voidsetDescription(String description) Opis pliku.voidsetDocumentClassId(Long documentClassId) Id klasy dokumentów do której dodajemy plik.voidsetExactIndexesCheck(boolean exactIndexesCheck) Określa, czy przy próbie zapisu dokumentu jako nowa wersja uwzględniać indeksy niezdefiniowane w mapie indeksów (jako sprawdzenie "is null") a istniejące dla tej klasy dokumentów.voidsetFileName(String fileName) Wyświetlana nazwa pliku.voidsetIndexes(Map<Long, Object> indexes) Indeksy dodawanago dokumentu.voidsetInputStream(InputStream inputStream) Strumień danych pliku.voidsetOCRContent(String oCRContent) Parametr służy do przechowywania treści dokumentu zeskanowanego.voidsetProcessId(String processId) Id procesu do którego chcemy dołączyć plik.voidsetSaveAsNewVersion(boolean saveAsNewVersion) Określa, czy zapisać plik jako nowa wersja(dodanie nowej wersji jest możliwe tylko, gdy dodawany dokument ma takie same indeksy jak istniejący już dokument w archiwum).voidsetUserName(String userName) Nazwa użytkownika, który dodaje plik.
-
Constructor Details
-
DocumentDefinition
public DocumentDefinition(boolean saveAsNewVersion) -
DocumentDefinition
public DocumentDefinition()
-
-
Method Details
-
getDocumentClassId
Id klasy dokumentów do której dodajemy plik. Wymagany.- Returns:
-
setDocumentClassId
Id klasy dokumentów do której dodajemy plik. Wymagany.- Parameters:
documentClassId-
-
getFileName
Wyświetlana nazwa pliku. Wymagany.- Returns:
-
setFileName
Wyświetlana nazwa pliku. Wymagany.- Parameters:
fileName-
-
getDescription
Opis pliku. Opcjonalny, domyślnie nazwa klasy dokumentów.- Returns:
-
setDescription
Opis pliku. Opcjonalny, domyślnie nazwa klasy dokumentów.- Parameters:
description-
-
getUserName
Nazwa użytkownika, który dodaje plik. Wymagany.- Returns:
-
setUserName
Nazwa użytkownika, który dodaje plik. Wymagany.- Parameters:
userName-
-
getInputStream
Strumień danych pliku. Wymagany.- Returns:
-
setInputStream
Strumień danych pliku. Wymagany.- Parameters:
inputStream-
-
getProcessId
Id procesu do którego chcemy dołączyć plik. Opcjonalny.- Returns:
-
setProcessId
Id procesu do którego chcemy dołączyć plik. Opcjonalny.- Parameters:
processId-
-
getActivityId
Id zadania do którego chcemy dołączyć plik. Opcjonalny.- Returns:
-
setActivityId
Id zadania do którego chcemy dołączyć plik. Opcjonalny.- Parameters:
activityId-
-
getIndexes
Indeksy dodawanago dokumentu. Kluczem mapy jest id indeksu. Opcjonalny.- Returns:
-
setIndexes
Indeksy dodawanago dokumentu. Kluczem mapy jest id indeksu. Opcjonalny.- Parameters:
indexes-
-
isSaveAsNewVersion
public boolean isSaveAsNewVersion()Określa, czy zapisać plik jako nowa wersja(dodanie nowej wersji jest możliwe tylko, gdy dodawany dokument ma takie same indeksy jak istniejący już dokument w archiwum). Opcjonalny, domyślnie FALSE- Returns:
-
setSaveAsNewVersion
public void setSaveAsNewVersion(boolean saveAsNewVersion) Określa, czy zapisać plik jako nowa wersja(dodanie nowej wersji jest możliwe tylko, gdy dodawany dokument ma takie same indeksy jak istniejący już dokument w archiwum). Opcjonalny, domyślnie FALSE- Parameters:
saveAsNewVersion-
-
getExactIndexesCheck
public boolean getExactIndexesCheck()Określa, czy przy próbie zapisu dokumentu jako nowa wersja uwzględniać indeksy niezdefiniowane w mapie indeksów (jako sprawdzenie "is null") a istniejące dla tej klasy dokumentów. Opcjonalny, domyślnie TRUE- Returns:
-
setExactIndexesCheck
public void setExactIndexesCheck(boolean exactIndexesCheck) Określa, czy przy próbie zapisu dokumentu jako nowa wersja uwzględniać indeksy niezdefiniowane w mapie indeksów (jako sprawdzenie "is null") a istniejące dla tej klasy dokumentów. Opcjonalny, domyślnie TRUE -
getOCRContent
Parametr służy do przechowywania treści dokumentu zeskanowanego. Jeżeli dodajemy dokument do klasy dokumentów, w której ustawiliśmy indeksowanie to wyszukiwanie wykorzysta wartość tego pola- Returns:
- Treść dokumentu
-
setOCRContent
Parametr służy do przechowywania treści dokumentu zeskanowanego. Jeżeli dodajemy dokument do klasy dokumentów, w której ustawiliśmy indeksowanie to wyszukiwanie wykorzysta wartość tego pola- Parameters:
oCRContent- Treść dokumentu
-
isAttachToClosedActivities
public boolean isAttachToClosedActivities() -
setAttachToClosedActivities
public void setAttachToClosedActivities(boolean attachToClosedActivities)
-