Package de.xima.fc.api.entity

Class ClientCounterApi

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.ClientCounterApi

public class ClientCounterApi
extends AEntityAPI<ClientCounter>

API for ClientCounters that can be accessed via APIProvider.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
ClientCounterApi()

Method Summary

Modifier and Type	Method	Description
ClientCounter	getByName(UserContext uc, Mandant client, String name)
ClientCounter	getByUuid(UserContext uc, Mandant client, UUID uuid)

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, 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 Details

ClientCounterApi

public ClientCounterApi()

Method Details

getByUuid

@Nullable
public ClientCounter getByUuid(UserContext uc,
 Mandant client,
 UUID uuid)

Parameters:

uc - UserContext to be used.

client - context to search for the counter.

uuid - UUID of the counter.

Returns:

The counter with the given UUID that belongs to the client, or null when no such counter exist.

Since:

7.0.0

getByName

@Nullable
public ClientCounter getByName(UserContext uc,
 Mandant client,
 String name)

Parameters:

uc - UserContext to be used.

client - context to search for the counter.

name - name of the counter.

Returns:

The counter with the given name that belongs to the client, or null when no such counter exist.

Since:

7.0.0