Package de.xima.fc.api.entity

Class MandantRessourcenAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.MandantRessourcenAPI

public class MandantRessourcenAPI
extends AEntityAPI<MandantRessource>

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
MandantRessourcenAPI()

Method Summary

Modifier and Type	Method	Description
MandantRessource	create(UserContext uc, String name, byte[] data, String userName, String fileName, Mandant mandant)	Method for creating a MandantRessource with the transmitted data.
List<MandantRessource>	getAllByMandant(UserContext uc, Mandant mandant)	Method for determining all MandantRessources for a client.
MandantRessource	getByName(UserContext uc, Mandant mandant, String name)	Method for determining the MandantRessource by his name.
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.
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[] data, String userName, String fileName, MandantRessource res)	Method for updating a MandantRessource with the transmitted data.

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

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, 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

MandantRessourcenAPI

public MandantRessourcenAPI()

Method Detail

getByName

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

Method for determining the MandantRessource by his name.

Parameters:

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

mandant - Mandant the client where the data are associated.

name - of the client ressource.

Returns:

MandantRessource with the transmitted name.

getAllByMandant

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

Method for determining all MandantRessources for a client.

Parameters:

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

mandant - Mandant the client where the data are associated.

Returns:

List of all MandantRessources for a client.

create

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

Method for creating a MandantRessource with the transmitted data.

Parameters:

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

name - of the MandantRessource.

data - of the MandantRessource.

userName - String the name of the user.

fileName - String the name of the file.

mandant - Mandant the client where the data are associated.

Returns:

The created MandantRessource.

update

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

Method for updating a MandantRessource with the transmitted data.

Parameters:

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

data - of the MandantRessource.

userName - String the name of the user.

fileName - String the name of the file.

res - MandantRessource which should updated.

Returns:

The updated MandantRessource.

getDownloadRessource

@Deprecated(forRemoval=true,
            since="8.3.0")
public 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

public 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

public 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

public 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

public 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