Class AttachmentHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.AttachmentHandler

All Implemented Interfaces:

IAPIHandler, IAttachmentHandler, IGenericHandler, Serializable

public class AttachmentHandler
extends GenericHandler
implements IAttachmentHandler

The Class AttachmentHandler.

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
AttachmentHandler()

Method Summary

Modifier and Type	Method	Description
Attachment	createByUser(UserContext uc, String username, Attachment attachment)
boolean	deleteByUser(UserContext uc, String username, boolean force, Attachment... attachments)
List<Attachment>	getAllBy(UserContext uc, Vorgang vorgang, EAttachmentSource source, String uuid)
byte[]	getAllZipped(UserContext uc, String prozessID)
Attachment	getByName(UserContext uc, Vorgang vorgang, String name)
PagedResult<Attachment>	getByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, int page, int pageSize)	Finds the attachments of the form record given by its UUID if the given user can access the form record and the attachment.
Attachment	getByUUID(UserContext uc, String uuid)
Attachment	getByUUID(UserContext uc, String uuid, Vorgang v)
Attachment	getByUuidAndUser(UserContext uc, UUID attachmentUuid, IUser user)	Finds the attachment for the given UUID if the user can access the attachment.
List<Attachment>	mergeAllByUser(UserContext uc, String username, List<AttachmentPersistData> attachmentData)	Creates or updates a list of attachments.
Attachment	updateByUser(UserContext uc, String username, String oldFileName, Attachment attachment)

Methods inherited from class GenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, serializableList, update, update

Methods inherited from class AMSApiHandler

getName

Methods inherited from class Object

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

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Constructor Details

AttachmentHandler

public AttachmentHandler()

Method Details

deleteByUser

public boolean deleteByUser(UserContext uc,
 String username,
 boolean force,
 Attachment... attachments)

Specified by:

deleteByUser in interface IAttachmentHandler

getAllBy

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

Specified by:

getAllBy in interface IAttachmentHandler

getAllZipped

public byte[] getAllZipped(UserContext uc,
 String prozessID)
                    throws IOException

Specified by:

getAllZipped in interface IAttachmentHandler

Throws:

IOException

getByUUID

public Attachment getByUUID(UserContext uc,
 String uuid)

Specified by:

getByUUID in interface IAttachmentHandler

getByUUID

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

Specified by:

getByUUID in interface IAttachmentHandler

getByUuidAndUser

public Attachment getByUuidAndUser(UserContext uc,
 UUID attachmentUuid,
 IUser user)

Description copied from interface: IAttachmentHandler

Finds the attachment for the given UUID if the user can access the attachment. User can access an attachment if they can access the form record of the attachment and the attachment itself.

Specified by:

getByUuidAndUser in interface IAttachmentHandler

Parameters:

uc - user context for database transactions.

attachmentUuid - UUID of the request attachment.

user - to get the attachment for. The user is assumed to be the end user.

Returns:

the form record attachment if the user can access it and null otherwise.

getByName

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

Specified by:

getByName in interface IAttachmentHandler

getByRecordAndUser

public PagedResult<Attachment> getByRecordAndUser(UserContext uc,
 UUID formRecordUuid,
 IUser user,
 int page,
 int pageSize)

Description copied from interface: IAttachmentHandler

Finds the attachments of the form record given by its UUID if the given user can access the form record and the attachment.

Specified by:

getByRecordAndUser in interface IAttachmentHandler

Parameters:

uc - user context for accessing the database.

formRecordUuid - the UUID of the form record

user - to get the attachments for. The user is assumed to be the end user.

page - to get. If a page less than or equal to zero is given, paging is disabled and all entities are returned in one page.

pageSize - size of the page to get. If a page size less than zerois given, paging is disabled and all entities are returned in one page.

Returns:

a list of form record attachment of the form record the user has access to ordered by their upload date (desc). null if the form record given by the UUID could not be found.

createByUser

public Attachment createByUser(UserContext uc,
 String username,
 Attachment attachment)

Specified by:

createByUser in interface IAttachmentHandler

mergeAllByUser

public List<Attachment> mergeAllByUser(UserContext uc,
 String username,
 List<AttachmentPersistData> attachmentData)

Description copied from interface: IAttachmentHandler

Creates or updates a list of attachments. This behaves as if IAttachmentHandler.createByUser(UserContext, String, Attachment) or IAttachmentHandler.updateByUser(UserContext, String, String, Attachment) had been called on each attachment. This method allows the attachments to be created / updated in a batch, so they do not have to be send individually over the network.

Specified by:

mergeAllByUser in interface IAttachmentHandler

Parameters:

uc - User context of the user who initiated the action.

username - Name of the user.

attachmentData - List of attachments to create or update.

Returns:

The created or updated attachments.

updateByUser

public Attachment updateByUser(UserContext uc,
 String username,
 String oldFileName,
 Attachment attachment)

Specified by:

updateByUser in interface IAttachmentHandler