Package de.xima.fc.api.entity

Class UserEmailAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.UserEmailAPI

public class UserEmailAPI
extends AEntityAPI<UserEmail>

API class for reading and writing UserEmail entities.

Since:

8.0.0

Author:

XIMA Media GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
UserEmailAPI()

Method Summary

Modifier and Type	Method	Description
List<UserEmail>	getByAddress(UserContext uc, String address)	Finds the user email entities with the given address.
UserEmail	getByVerifiedAddress(UserContext uc, String address)	Finds the verified user email entity with the given address.

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 Detail

UserEmailAPI

public UserEmailAPI()

Method Detail

getByAddress

public List<UserEmail> getByAddress(UserContext uc,
                                    String address)

Finds the user email entities with the given address. There may be multiple user email entities with the same address. But there can only be one verified user email with the given address.

Parameters:

uc - user context for accessing the database.

address - of the user email entity (case irrelevant).

Returns:

A list of user email entities with the given email address.

getByVerifiedAddress

public UserEmail getByVerifiedAddress(UserContext uc,
                                      String address)

Finds the verified user email entity with the given address. There may only be one verified user email entity with the given address.

Parameters:

uc - user context for accessing the database.

address - of the verified user email entity (case irrelevant).

Returns:

The verified user email entity with the given email address or null.