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
List<UserPortal>	getAllClientPortals(IEntityContext ec, Mandant client)	Returns all client user portal entities for the given client.
List<UserPortal>	getAllSystemPortals(IEntityContext ec)	Returns all system user portal entities.
UserPortal	getByAlias(IEntityContext ec, String alias)
UserPortal	getByName(IEntityContext ec, String name)
UserPortal	getByUuid(IEntityContext ec, UUID uuid)	Returns the user portal entity with the given UUID.
UserPortalFile	getFileByUuid(IEntityContext ec, UUID portalUuid, UUID fileUuid)	Returns the user portal file 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

getAllClientPortals

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

Returns all client user portal entities for the given client.

Parameters:

ec - entity context for database transactions.

client - to get the user portals for.

Returns:

all client user portal entities for the given client.

getAllSystemPortals

List<UserPortal> getAllSystemPortals(IEntityContext ec)

Returns all system user portal entities.

Parameters:

ec - entity context for database transactions.

Returns:

all system user portal entities.

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.

getByAlias

UserPortal getByAlias(IEntityContext ec,
                      String alias)

getByName

UserPortal getByName(IEntityContext ec,
                     String name)

getFileByUuid

UserPortalFile getFileByUuid(IEntityContext ec,
                             UUID portalUuid,
                             UUID fileUuid)

Returns the user portal file entity with the given UUID.

Parameters:

ec - Entity context for database transactions.

portalUuid - UUID of the user portal to get the file for.

fileUuid - UUID of the file to get.

Returns:

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

Throws:

de.xima.cmn.http.exception.NotFoundException - if the file or user portal does not exist.

Since:

8.4.0

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.

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.