de.xima.fc.api.entity

Class AttachmentAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<Attachment>

de.xima.fc.api.entity.AttachmentAPI

public class AttachmentAPI
extends AEntityAPI<Attachment>

API-Klasse zur Manipulation von Attachment-Entitäten

Author:

Michael Kohlsche

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor and Description
AttachmentAPI()

Method Summary

Modifier and Type	Method and Description
boolean	checkAttachmentsHash(UserContext uc, String prozessId, String sessionId, int hash) Methode zum Überprüfen ob der Hashkey für die Attachmets eines Vorgangs korrekt ist
Boolean	delete(UserContext uc, Attachment attachment) Methode zum Löschen eines Attachments
Boolean	delete(UserContext uc, Attachment[] attachments) Methode zum Löschen mehrerer Attachments
List<Attachment>	getAllBy(UserContext uc, Vorgang vorgang, EAttachmentSource source, String uuid)
Attachment	getAttachment(UserContext uc, String prozessId, String sessionId, int hash) Methode zum Auflösen eines Hashkeys zu einem Attachment-Namen
InputStream	getAttachmentFileStream(UserContext uc, String prozessID, int id) Methode zum Auslesen einer Attachment-Datei
InputStream	getAttachmentFileStream(UserContext uc, String prozessID, String name) Methode zum Auslesen einer Attachment-Datei
List<Attachment>	getAttachmentList(UserContext uc, String prozessID) Methode zur Ausgabe aller Attachments eines Prozesses
List<Attachment>	getAttachmentListByType(UserContext uc, String prozessID, EAttachmentSource source)
Attachment	getByName(UserContext uc, Vorgang vorgang, String name)
Attachment	getByUUID(UserContext uc, String atid)
Attachment	getByUUID(UserContext uc, String atid, Vorgang v)
InputStream	getZippedAttachments(UserContext uc, String prozessID) Methode zum Auslesen von Attachments als InputStream auf ein ZIP-Archiv

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, deleteAllBy, deleteById, getAll, getAllBy, getBy, getById, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentAPI

public AttachmentAPI()

Method Detail

delete

public Boolean delete(UserContext uc,
                      Attachment[] attachments)

Methode zum Löschen mehrerer Attachments

Overrides:

delete in class AEntityAPI<Attachment>

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

attachments - Array von Attachments die gelöscht werden sollen

Returns:

true wenn das Löschen erfolgreich war @

Since:

2.4.3

See Also:

de.xima.fc.api.entity.AEntityAPI#delete(de.xima.fc.user.UserContext, T[])

getAttachmentFileStream

public InputStream getAttachmentFileStream(UserContext uc,
                                           String prozessID,
                                           String name)
                                    throws FileNotFoundException

Methode zum Auslesen einer Attachment-Datei

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

prozessID - die Prozess-ID des Vorgangs für welchen das Attachment geladen werden soll

name - des Attachments, welches geladen werden soll

Returns:

InputStream auf das Attachment

Throws:

FileNotFoundException

Since:

2.4.3

getAttachmentFileStream

public InputStream getAttachmentFileStream(UserContext uc,
                                           String prozessID,
                                           int id)
                                    throws FileNotFoundException

Methode zum Auslesen einer Attachment-Datei

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

prozessID - die Prozess-ID des Vorgangs für welchen das Attachment geladen werden soll

id - des Attachments, welches geladen werden soll

Returns:

InputStream auf das Attachment

Throws:

FileNotFoundException

Since:

2.4.3

getAttachmentList

public List<Attachment> getAttachmentList(UserContext uc,
                                          String prozessID)

Methode zur Ausgabe aller Attachments eines Prozesses

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

prozessID - die Prozess-ID des Vorgangs für welchen das Attachment geladen werden soll

Returns:

Liste mit Attachments des Vorgangs

Since:

2.4.3

getAttachmentListByType

public List<Attachment> getAttachmentListByType(UserContext uc,
                                                String prozessID,
                                                EAttachmentSource source)

Parameters:

uc -

prozessID -

source -

Returns:

Since:

3.1.7

getZippedAttachments

public InputStream getZippedAttachments(UserContext uc,
                                        String prozessID)
                                 throws IOException

Methode zum Auslesen von Attachments als InputStream auf ein ZIP-Archiv

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

prozessID - die Prozess-ID des Vorgangs für welchen das Attachment geladen werden soll

Returns:

InputStream auf alle Attachments des Vorgangs als ZIP

Throws:

IOException - @

Since:

2.4.3

delete

public Boolean delete(UserContext uc,
                      Attachment attachment)

Methode zum Löschen eines Attachments

Overrides:

delete in class AEntityAPI<Attachment>

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

attachment - das gelöscht werden soll

Returns:

true wenn das Löschen erfolgreich war @

Since:

2.4.3

See Also:

de.xima.fc.api.entity.AEntityAPI#delete(de.xima.fc.user.UserContext, de.xima.fc.entities.AbstractEntity)

checkAttachmentsHash

public boolean checkAttachmentsHash(UserContext uc,
                                    String prozessId,
                                    String sessionId,
                                    int hash)

Methode zum Überprüfen ob der Hashkey für die Attachmets eines Vorgangs korrekt ist

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

prozessId - die Prozess-ID des Vorgangs für welchen das Attachment geladen werden soll

sessionId - die aktuelle Session-ID des Nutzers

hash - gegen den geprüft werden soll

Returns:

true wenn die Hash-Werte identisch sind

Since:

2.4.3

getAttachment

public Attachment getAttachment(UserContext uc,
                                String prozessId,
                                String sessionId,
                                int hash)

Methode zum Auflösen eines Hashkeys zu einem Attachment-Namen

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

prozessId - die Prozess-ID des Vorgangs für welchen das Attachment geladen werden soll

sessionId - die aktuelle Session-ID des Nutzers

hash - Hash-Wert der genutzt wird um zu Prüfen dass das korrekte Attachment ausgeliefert wird

Returns:

Attachment wenn Vorgang vorhanden und das Attachment existiert, ansonsten null

Since:

2.4.3

getByUUID

public Attachment getByUUID(UserContext uc,
                            String atid)

getByUUID

public Attachment getByUUID(UserContext uc,
                            String atid,
                            Vorgang v)

getByName

public Attachment getByName(UserContext uc,
                            Vorgang vorgang,
                            String name)

getAllBy

public List<Attachment> getAllBy(UserContext uc,
                                 Vorgang vorgang,
                                 EAttachmentSource source,
                                 String uuid)