Package de.xima.fc.handler.interfaces.entity

Interface IMandantRessourcenHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

MandantRessourceHandler

public interface IMandantRessourcenHandler
extends IGenericHandler

Method Summary

Modifier and Type	Method	Description
MandantRessource	create(UserContext uc, String name, byte[] daten, String userName, String fileName, Mandant mandant)
List<MandantRessource>	getAllByMandant(UserContext uc, Mandant mandant)
MandantRessource	getByName(UserContext uc, Mandant mandant, String name)
MandantRessource	getByUUID(UserContext uc, UUID clientUuid, UUID uuid)	Gets a client resource by its UUID.
MandantRessource	getDownloadResource(UserContext uc, long clientId, String resourceName)	Finds a client resource by its resource name.
MandantRessource	getDownloadResource(UserContext uc, UUID clientUuid, String resourceName)	Finds a client resource by its resource name.
MandantRessource	getDownloadRessource(UserContext uc, Integer mandantId, String resourceName)	Deprecated, for removal: This API element is subject to removal in a future version. Use getDownloadResource(UserContext, long, String) instead.
TenantResourceLocalizedFile	getUserPortalTenantResourceLocalizedFile(UserContext uc, UUID portalUuid, UUID tenantUuid, UUID tenantResourceUuid, UUID fileUuid)	Returns the tenant resource file with the given file UUID in the context of the user portal with the given UUID.
ETagResource<ByteArrayFile>	handleDownloadResourceRequest(UserContext uc, long clientId, String resourceName, ETagRequest eTagRequest)	Finds the content of a client resource by its resource name.
ETagResource<ByteArrayFile>	handleDownloadResourceRequest(UserContext uc, UUID clientUuid, String resourceName, ETagRequest eTagRequest)	Finds the content of a client resource by its resource name.
MandantRessource	update(UserContext uc, byte[] daten, String userName, String fileName, MandantRessource res)

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

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

Method Detail

getByName

MandantRessource getByName(UserContext uc,
                           Mandant mandant,
                           String name)

getAllByMandant

List<MandantRessource> getAllByMandant(UserContext uc,
                                       Mandant mandant)

create

MandantRessource create(UserContext uc,
                        String name,
                        byte[] daten,
                        String userName,
                        String fileName,
                        Mandant mandant)

update

MandantRessource update(UserContext uc,
                        byte[] daten,
                        String userName,
                        String fileName,
                        MandantRessource res)

getDownloadRessource

@Deprecated(forRemoval=true,
            since="8.3.0")
MandantRessource getDownloadRessource(UserContext uc,
                                      Integer mandantId,
                                      String resourceName)

Deprecated, for removal: This API element is subject to removal in a future version.

Use getDownloadResource(UserContext, long, String) instead.

Finds a client resource by its resource name.

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandantId - the id of the client.

resourceName - the name of the resource.

Returns:

MandantRessource with the resource name.

getDownloadResource

MandantRessource getDownloadResource(UserContext uc,
                                     long clientId,
                                     String resourceName)

Finds a client resource by its resource name.

Parameters:

uc - UserContext the user context in which the action is to be performed.

clientId - The ID of the client.

resourceName - the name of the resource.

Returns:

MandantRessource with the resource name.

Since:

8.3.0

getDownloadResource

MandantRessource getDownloadResource(UserContext uc,
                                     UUID clientUuid,
                                     String resourceName)

Finds a client resource by its resource name.

Parameters:

uc - UserContext the user context in which the action is to be performed.

clientUuid - The ID of the client.

resourceName - the name of the resource.

Returns:

MandantRessource with the resource name.

Since:

8.3.0

handleDownloadResourceRequest

ETagResource<ByteArrayFile> handleDownloadResourceRequest(UserContext uc,
                                                          long clientId,
                                                          String resourceName,
                                                          ETagRequest eTagRequest)

Finds the content of a client resource by its resource name. Returns nothing if the resource has not been modified according to the given ETag request.

Parameters:

uc - UserContext the user context in which the action is to be performed.

clientId - The ID of the client.

resourceName - the name of the resource.

eTagRequest - The ETag request.

Returns:

The content of the requested client resource, if modified.

Since:

8.3.0

handleDownloadResourceRequest

ETagResource<ByteArrayFile> handleDownloadResourceRequest(UserContext uc,
                                                          UUID clientUuid,
                                                          String resourceName,
                                                          ETagRequest eTagRequest)

Finds the content of a client resource by its resource name. Returns nothing if the resource has not been modified according to the given ETag request.

Parameters:

uc - UserContext the user context in which the action is to be performed.

clientUuid - The UUID of the client.

resourceName - the name of the resource.

eTagRequest - The ETag request.

Returns:

The content of the requested client resource, if modified.

Since:

8.3.0

getByUUID

MandantRessource getByUUID(UserContext uc,
                           UUID clientUuid,
                           UUID uuid)

Gets a client resource by its UUID. The client resource must owned by the given client.

Parameters:

uc - User context of the user who wishes to get the client resource.

clientUuid - UUID of the client.

uuid - UUID of the client resource.

Returns:

The client resource or null if it does not exist.

Since:

8.6.0

getUserPortalTenantResourceLocalizedFile

TenantResourceLocalizedFile getUserPortalTenantResourceLocalizedFile(UserContext uc,
                                                                     UUID portalUuid,
                                                                     UUID tenantUuid,
                                                                     UUID tenantResourceUuid,
                                                                     UUID fileUuid)

Returns the tenant resource file with the given file UUID in the context of the user portal with the given UUID.

Parameters:

uc - User context for accessing the database.

portalUuid - UUID of the user portal (context).

tenantUuid - UUID of the client (context).

tenantResourceUuid - UUID of the tenant resource.

fileUuid - UUID of the tenant resource file.

Returns:

The tenant resource file with the given UUID, or null if no such tenant resource file exists.

Throws:

de.xima.cmn.http.exception.NotFoundException - if no portal with the given UUID exists, if no client with the given UUID exists, or if no tenant resource with the given UUID exists.

Since:

8.4.0