Package de.xima.fc.dao.interfaces

Interface IMandantRessourceDao

All Superinterfaces:

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

All Known Implementing Classes:

MandantRessourceDao

public interface IMandantRessourceDao
extends IGenericDao<MandantRessource>

Method Summary

Modifier and Type	Method	Description
MandantRessource	create(IEntityContext ec, String name, byte[] daten, String userName, String fileName, Mandant mandant)
MandantRessource	create(IEntityContext ec, String name, byte[] daten, String userName, String fileName, String resourceDescription, Mandant mandant)
String	findUniqueName(IEntityContext ec, Mandant client, String candidate, MandantRessource exclude)	Returns a name that is not taken by another MandantRessource in the given client.
List<MandantRessource>	getAllByExtension(IEntityContext ec, Mandant client, Iterable<String> extensions)
default List<MandantRessource>	getAllByMandant(Mandant mandant, IEntityContext ec)	Deprecated. use getAllByMandant(IEntityContext, Mandant)
List<MandantRessource>	getAllByMandant(IEntityContext ec, Mandant mandant)
List<MandantRessource>	getAllByProject(IEntityContext ec, Projekt project)	Deprecated. This only applies to the old workflow engine.
default MandantRessource	getByName(Mandant mandant, String name, IEntityContext ec)	Deprecated. use getByName(IEntityContext, Mandant, String)
MandantRessource	getByName(IEntityContext ec, Mandant mandant, String name)
MandantRessource	getByUUID(IEntityContext ec, Mandant client, String uuid)	Returns the client resource for the given UUID string and client
MandantRessource	getByUUID(IEntityContext ec, Mandant client, UUID uuid)	Returns the client resource for the given UUID and client
long	getUsedFileSize(IEntityContext ec, Mandant mandant)
boolean	isNameExisiting(IEntityContext ec, Mandant client, String name)	Returns whether or not the given client resource name exists within the given client
MandantRessource	update(IEntityContext ec, byte[] daten, String userName, String fileName, MandantRessource res)

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 de.xima.fc.dao.interfaces.IGenericDao

getEntityRefs, read

Method Detail

getByName

MandantRessource getByName(IEntityContext ec,
                           Mandant mandant,
                           String name)

getByName

@Deprecated
default MandantRessource getByName(Mandant mandant,
                                   String name,
                                   IEntityContext ec)

Deprecated.

use getByName(IEntityContext, Mandant, String)

getByUUID

MandantRessource getByUUID(IEntityContext ec,
                           Mandant client,
                           String uuid)

Returns the client resource for the given UUID string and client

Parameters:

ec - IEntityContext to use

client - Mandant context in which to look for resource

uuid - String UUID string of the resource

Returns:

MandantRessource for the given UUID and client

Since:

6.1.0

getByUUID

MandantRessource getByUUID(IEntityContext ec,
                           Mandant client,
                           UUID uuid)

Returns the client resource for the given UUID and client

Parameters:

ec - IEntityContext to use

client - Mandant context in which to look for resource

uuid - UUID UUID of the resource

Returns:

MandantRessource for the given UUID and client

Since:

6.1.0

findUniqueName

String findUniqueName(IEntityContext ec,
                      Mandant client,
                      String candidate,
                      MandantRessource exclude)

Returns a name that is not taken by another MandantRessource in the given client. An index will be added to the candidate if necessary.

Parameters:

ec - IEntityContext to be used

client - Mandant for which a unique client resource name should be generated

candidate - String client resource name candiate to be made unique

exclude - MandantRessource client resource to be excluded from the search

Returns:

unique client resource name in the context of the given client

Since:

6.4.0

isNameExisiting

boolean isNameExisiting(IEntityContext ec,
                        Mandant client,
                        String name)

Returns whether or not the given client resource name exists within the given client

Parameters:

ec - IEntityContext to be used

client - Mandant for which to check uniqueness

name - String client resource name to check

Returns:

whether or not the given name is unique

Since:

6.4.0

getAllByMandant

@Deprecated
default List<MandantRessource> getAllByMandant(Mandant mandant,
                                               IEntityContext ec)

Deprecated.

use getAllByMandant(IEntityContext, Mandant)

getAllByMandant

List<MandantRessource> getAllByMandant(IEntityContext ec,
                                       Mandant mandant)

getAllByProject

@Deprecated
List<MandantRessource> getAllByProject(IEntityContext ec,
                                       Projekt project)

Deprecated.

This only applies to the old workflow engine. Use other methods such as IElementHandler.readEntityReferences(IReadEntityRefsParams) for the new workflow engine.

Returns all client resources that are being used by the given project

Parameters:

ec - Current entity context for accessing the database.

project - A project where to search.

Returns:

A list of client resources that are used by the project's workflow configration.

Since:

6.1.0

create

MandantRessource create(IEntityContext ec,
                        String name,
                        byte[] daten,
                        String userName,
                        String fileName,
                        Mandant mandant)

create

MandantRessource create(IEntityContext ec,
                        String name,
                        byte[] daten,
                        String userName,
                        String fileName,
                        String resourceDescription,
                        Mandant mandant)

update

MandantRessource update(IEntityContext ec,
                        byte[] daten,
                        String userName,
                        String fileName,
                        MandantRessource res)

getUsedFileSize

long getUsedFileSize(IEntityContext ec,
                     Mandant mandant)

getAllByExtension

List<MandantRessource> getAllByExtension(IEntityContext ec,
                                         Mandant client,
                                         Iterable<String> extensions)

Parameters:

ec - Current entity context for accessing the database.

client - Client for which to fetch resources.

extensions - Extensions to search for.

Returns:

All project resources that belong to the given project and have one of the given extensions. When no extension is given, an empty list is returned.