Package de.xima.fc.dao.interfaces

Interface IUserPortalDao

All Superinterfaces:

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

All Known Implementing Classes:

UserPortalDao

public interface IUserPortalDao
extends IGenericDao<UserPortal>

DAO for reading and writing UserPortal entities.

Since:

8.2.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
void	assertUserPortal(IEntityContext ec, UserPortal portal)	Checks if the user portal can be persisted (create/update).
List<UserPortal>	getAllByClient(IEntityContext ec, Mandant client)	Returns all user portal entities available for the given client.
UserPortal	getByUuid(IEntityContext ec, UUID uuid)	Returns the user portal entity with the given UUID.
PagedResult<UserPortal>	getForFrontendServer(IEntityContext ec, FrontendServer frontendServer, int page, int pageSize)	Returns all user portal entities available on the given frontend server.
PagedResult<UserPortal>	getForMasterServer(IEntityContext ec, int page, int pageSize)	Returns all user portal entities available on the master server.

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

count, findAll, findSingle, getEntityRefs, read

Method Detail

assertUserPortal

void assertUserPortal(IEntityContext ec,
                      UserPortal portal)

Checks if the user portal can be persisted (create/update). If the state of the user portal does not allow persisting than a DatabaseAccessException will be thrown.

Parameters:

ec - Entity context for accessing the database.

portal - A portal to check.

Throws:

de.xima.cmn.dao.exceptions.DatabaseAccessException - if the user identity can't be persisted.

getAllByClient

List<UserPortal> getAllByClient(IEntityContext ec,
                                Mandant client)

Returns all user portal entities available for the given client.

Parameters:

ec - entity context for database transactions.

client - to get the user portals for.

Returns:

all user portal entities available for the given client.

getByUuid

UserPortal getByUuid(IEntityContext ec,
                     UUID uuid)

Returns the user portal entity with the given UUID.

Parameters:

ec - Entity context for database transactions.

uuid - UUID of the user portal to get.

Returns:

The user portal entity with the given UUID, or null if no such entity exists.

getForMasterServer

PagedResult<UserPortal> getForMasterServer(IEntityContext ec,
                                           int page,
                                           int pageSize)

Returns all user portal entities available on the master server.

Parameters:

ec - entity context for database transactions.

page - to get.

pageSize - size of the page to get. Defines the size of the returned sub list.

Returns:

all user portal entities available on the master server.

getForFrontendServer

PagedResult<UserPortal> getForFrontendServer(IEntityContext ec,
                                             FrontendServer frontendServer,
                                             int page,
                                             int pageSize)

Returns all user portal entities available on the given frontend server.

Parameters:

ec - entity context for database transactions.

frontendServer - to get the user portals for.

page - to get.

pageSize - size of the page to get. Defines the size of the returned sub list.

Returns:

all user portal entities available on the given frontend server.