com.suncode.pwfl.archive.util

Class DocumentDefinition

java.lang.Object

com.suncode.pwfl.archive.util.DocumentDefinition

public class DocumentDefinition
extends Object

Obiek służący do defniowania specyficznych parametrów podczas dodawania dokumentu do archiwum

Author:

Paweł Rosolak 16 paź 2013

Constructor Summary

Constructors

Constructor and Description
DocumentDefinition()
DocumentDefinition(boolean saveAsNewVersion)

Method Summary

Modifier and Type	Method and Description
String	getActivityId() Id zadania do którego chcemy dołączyć plik.
String	getDescription() Opis pliku.
Long	getDocumentClassId() Id klasy dokumentów do której dodajemy plik.
String	getFileName() Wyświetlana nazwa pliku.
Map<Long,Object>	getIndexes() Indeksy dodawanago dokumentu.
InputStream	getInputStream() Strumień danych pliku.
String	getOCRContent() Parametr służy do przechowywania treści dokumentu zeskanowanego.
String	getProcessId() Id procesu do którego chcemy dołączyć plik.
String	getUserName() Nazwa użytkownika, który dodaje plik.
boolean	isAttachToClosedActivities()
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).
void	setActivityId(String activityId) Id zadania do którego chcemy dołączyć plik.
void	setAttachToClosedActivities(boolean attachToClosedActivities)
void	setDescription(String description) Opis pliku.
void	setDocumentClassId(Long documentClassId) Id klasy dokumentów do której dodajemy plik.
void	setFileName(String fileName) Wyświetlana nazwa pliku.
void	setIndexes(Map<Long,Object> indexes) Indeksy dodawanago dokumentu.
void	setInputStream(InputStream inputStream) Strumień danych pliku.
void	setOCRContent(String oCRContent) Parametr służy do przechowywania treści dokumentu zeskanowanego.
void	setProcessId(String processId) Id procesu do którego chcemy dołączyć plik.
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).
void	setUserName(String userName) Nazwa użytkownika, który dodaje plik.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentDefinition

public DocumentDefinition(boolean saveAsNewVersion)

DocumentDefinition

public DocumentDefinition()

Method Detail

getDocumentClassId

public Long getDocumentClassId()

Id klasy dokumentów do której dodajemy plik. Wymagany.

Returns:

setDocumentClassId

public void setDocumentClassId(Long documentClassId)

Id klasy dokumentów do której dodajemy plik. Wymagany.

Parameters:

documentClassId -

getFileName

public String getFileName()

Wyświetlana nazwa pliku. Wymagany.

Returns:

setFileName

public void setFileName(String fileName)

Wyświetlana nazwa pliku. Wymagany.

Parameters:

fileName -

getDescription

public String getDescription()

Opis pliku. Opcjonalny, domyślnie nazwa klasy dokumentów.

Returns:

setDescription

public void setDescription(String description)

Opis pliku. Opcjonalny, domyślnie nazwa klasy dokumentów.

Parameters:

description -

getUserName

public String getUserName()

Nazwa użytkownika, który dodaje plik. Wymagany.

Returns:

setUserName

public void setUserName(String userName)

Nazwa użytkownika, który dodaje plik. Wymagany.

Parameters:

userName -

getInputStream

public InputStream getInputStream()

Strumień danych pliku. Wymagany.

Returns:

setInputStream

public void setInputStream(InputStream inputStream)

Strumień danych pliku. Wymagany.

Parameters:

inputStream -

getProcessId

public String getProcessId()

Id procesu do którego chcemy dołączyć plik. Opcjonalny.

Returns:

setProcessId

public void setProcessId(String processId)

Id procesu do którego chcemy dołączyć plik. Opcjonalny.

Parameters:

processId -

getActivityId

public String getActivityId()

Id zadania do którego chcemy dołączyć plik. Opcjonalny.

Returns:

setActivityId

public void setActivityId(String activityId)

Id zadania do którego chcemy dołączyć plik. Opcjonalny.

Parameters:

activityId -

getIndexes

public Map<Long,Object> getIndexes()

Indeksy dodawanago dokumentu. Kluczem mapy jest id indeksu. Opcjonalny.

Returns:

setIndexes

public void setIndexes(Map<Long,Object> indexes)

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 -

getOCRContent

public String 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

public void setOCRContent(String oCRContent)

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)