Class AttachmentDao

java.lang.Object

de.xima.cmn.dao.AbstractDao<Attachment, Long, IEntityContext>

de.xima.fc.dao.impl.GenericDao<Attachment>

de.xima.fc.dao.impl.AttachmentDao

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IAbstractDao<Attachment, Long, IEntityContext>, IAttachmentDao, IGenericDao<Attachment>

public class AttachmentDao
extends GenericDao<Attachment>
implements IAttachmentDao

Field Summary

Fields inherited from class de.xima.cmn.dao.AbstractDao

entityClass, LOG

Constructor Summary

Constructors

Constructor	Description
AttachmentDao()

Method Summary

Modifier and Type	Method	Description
int	clearOriginalAttachmentReferences(IEntityContext ec, Attachment... attachments)	Finds and resets 'original attachment' references to the provided attachments.
Attachment	createByUser(IEntityContext ec, String username, Attachment attachment)
Attachment	createByUser(IEntityContext ec, String username, Attachment attachment, List<ProtocolEntryProcessing> protocolEntries)
void	deleteByUser(IEntityContext ec, String username, boolean force, Attachment... attachments)
void	deleteByUser(IEntityContext ec, String username, Attachment... attachments)
void	deleteByUuid(IEntityContext ec, String uuid, Vorgang formRecord)	Deletes the attachment of the given form record with the given UUID
List<Attachment>	getAllBy(IEntityContext ec, Vorgang vorgang, EAttachmentSource source, String uuid)
Attachment	getByName(IEntityContext ec, Vorgang vorgang, String name)
PagedResult<Attachment>	getByRecordAndUser(IEntityContext ec, 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 attachments itself.
Attachment	getByUUID(IEntityContext ec, String uuid)
Attachment	getByUUID(IEntityContext ec, String uuid, Vorgang v)
Attachment	getByUUID(IEntityContext ec, UUID uuid)	Returns the attachment with the given UUID
protected IFCDaoActionHook<Attachment>	getPreActionHook()
List<Attachment>	getUploadElementAttachments(IEntityContext ec, Vorgang formRecord)	Returns all attachments of the given form record that are associated with an upload element.
long	getUsedFileSize(IEntityContext ec, Mandant mandant)
Attachment	updateByUser(IEntityContext ec, String username, String oldFileName, Attachment attachment)
Attachment	updateByUser(IEntityContext ec, String username, String oldFileName, Attachment attachment, List<ProtocolEntryProcessing> protocolEntries)

Methods inherited from class GenericDao

getEntityRefs, getPostActionHook, read

Methods inherited from class de.xima.cmn.dao.AbstractDao

all, bulkDelete, bulkUpdate, cb, checkLockingVersion, cq, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, notifyListener, notifyListener, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from class Object

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

Methods inherited from interface de.xima.cmn.dao.interfaces.IAbstractDao

all, bulkDelete, bulkUpdate, checkLockingVersion, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from interface IGenericDao

count, createOrUpdate, findAll, findSingle, getEntityRefs, read

Constructor Details

AttachmentDao

public AttachmentDao()

Method Details

getAllBy

public List<Attachment> getAllBy(IEntityContext ec,
 Vorgang vorgang,
 EAttachmentSource source,
 String uuid)

Specified by:

getAllBy in interface IAttachmentDao

getUploadElementAttachments

public List<Attachment> getUploadElementAttachments(IEntityContext ec,
 Vorgang formRecord)

Description copied from interface: IAttachmentDao

Returns all attachments of the given form record that are associated with an upload element.

Specified by:

getUploadElementAttachments in interface IAttachmentDao

Parameters:

ec - Entity context for database operations.

formRecord - Form record to get the attachments for.

Returns:

List of attachments associated with an upload element ordered by the name of the upload element.

getByUUID

public Attachment getByUUID(IEntityContext ec,
 String uuid,
 Vorgang v)

Specified by:

getByUUID in interface IAttachmentDao

deleteByUuid

public void deleteByUuid(IEntityContext ec,
 String uuid,
 Vorgang formRecord)

Description copied from interface: IAttachmentDao

Deletes the attachment of the given form record with the given UUID

Specified by:

deleteByUuid in interface IAttachmentDao

Parameters:

ec - Entity context for database operations.

uuid - UUID of the attachment to delete

formRecord - Form record to delete the attachment from.

getByName

public Attachment getByName(IEntityContext ec,
 Vorgang vorgang,
 String name)

Specified by:

getByName in interface IAttachmentDao

getByUUID

public Attachment getByUUID(IEntityContext ec,
 String uuid)

Specified by:

getByUUID in interface IAttachmentDao

getByUUID

public Attachment getByUUID(IEntityContext ec,
 UUID uuid)

Description copied from interface: IAttachmentDao

Returns the attachment with the given UUID

Specified by:

getByUUID in interface IAttachmentDao

Parameters:

ec - IEntityContext to use

uuid - UUID UUID of the attachment

Returns:

Attachment for the given UUID

getByRecordAndUser

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

Description copied from interface: IAttachmentDao

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

Specified by:

getByRecordAndUser in interface IAttachmentDao

Parameters:

ec - entity 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.

deleteByUser

public void deleteByUser(IEntityContext ec,
 String username,
 Attachment... attachments)

Specified by:

deleteByUser in interface IAttachmentDao

deleteByUser

public void deleteByUser(IEntityContext ec,
 String username,
 boolean force,
 Attachment... attachments)

Specified by:

deleteByUser in interface IAttachmentDao

clearOriginalAttachmentReferences

public int clearOriginalAttachmentReferences(IEntityContext ec,
 Attachment... attachments)

Description copied from interface: IAttachmentDao

Finds and resets 'original attachment' references to the provided attachments.

Specified by:

clearOriginalAttachmentReferences in interface IAttachmentDao

Parameters:

ec - entity context for accessing the database.

attachments - attachments which might be referenced from other attachments as their 'original attachment'

Returns:

number of cleared references

updateByUser

public Attachment updateByUser(IEntityContext ec,
 String username,
 String oldFileName,
 Attachment attachment)

Specified by:

updateByUser in interface IAttachmentDao

updateByUser

public Attachment updateByUser(IEntityContext ec,
 String username,
 String oldFileName,
 Attachment attachment,
 List<ProtocolEntryProcessing> protocolEntries)

Specified by:

updateByUser in interface IAttachmentDao

Parameters:

ec - the entity context to use

username - the name of the involved user

oldFileName - the name of the file to be replaced (just for the protocol)

attachment - the attachment to update

protocolEntries - (modifiable) list of protocol entries

• note: general protocol entry properties as 'benutzer' will be set here in the DAO
• note: a concluding 'attachment updated' protocol entry for this update will also be added here

Returns:

the updated attachment

See Also:

• persistProtocolEntries(IEntityContext, String, Attachment, List)

createByUser

public Attachment createByUser(IEntityContext ec,
 String username,
 Attachment attachment)

Specified by:

createByUser in interface IAttachmentDao

createByUser

public Attachment createByUser(IEntityContext ec,
 String username,
 Attachment attachment,
 List<ProtocolEntryProcessing> protocolEntries)

Specified by:

createByUser in interface IAttachmentDao

Parameters:

ec - the entity context to use

username - the name of the involved user

attachment - the attachment to persist

protocolEntries - (modifiable) list of protocol entries

• note: general protocol entry properties as 'benutzer' will be set here in the DAO
• note: a concluding 'attachment created' protocol entry for this update will also be added here

Returns:

the persisted attachment

See Also:

• persistProtocolEntries(IEntityContext, String, Attachment, List)

getUsedFileSize

public long getUsedFileSize(IEntityContext ec,
 Mandant mandant)

Specified by:

getUsedFileSize in interface IAttachmentDao

getPreActionHook

protected IFCDaoActionHook<Attachment> getPreActionHook()

Overrides:

getPreActionHook in class GenericDao<Attachment>