Interface IUserPortalHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

UserPortalHandler

public interface IUserPortalHandler
extends IGenericHandler

Handler for UserPortal entities

Since:

8.2.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
UserPortal	getByAlias(UserContext uc, String alias)	Returns the user portal with the given alias.
UserPortal	getByName(UserContext uc, String name)	Returns the user portal with the given name.
UserPortal	getByUuid(UserContext uc, UUID uuid)	Returns the user portal with the given UUID.
UserPortalFile	getFileByUuid(UserContext uc, UUID portalUuid, UUID fileUuid)	Returns the user portal file with the given UUID.
PagedResult<UserPortal>	getForFrontendServer(UserContext uc, FrontendServer frontendServer, int page, int pageSize)	Returns all user portal entities available on the given frontend server.
PagedResult<UserPortal>	getForMasterServer(UserContext uc, int page, int pageSize)	Returns all user portal entities available on the master server.

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Details

getByAlias

UserPortal getByAlias(UserContext uc,
 String alias)

Returns the user portal with the given alias.

Parameters:

uc - user context for database transactions.

alias - of the user portal.

Returns:

the user portal with the given alias or null.

getByName

UserPortal getByName(UserContext uc,
 String name)

Returns the user portal with the given name.

Parameters:

uc - user context for database transactions.

name - of the user portal.

Returns:

the user portal with the given name or null.

getByUuid

UserPortal getByUuid(UserContext uc,
 UUID uuid)

Returns the user portal with the given UUID.

Parameters:

uc - user context for database transactions.

uuid - of the user portal.

Returns:

the user portal with the given UUID or null.

getFileByUuid

UserPortalFile getFileByUuid(UserContext uc,
 UUID portalUuid,
 UUID fileUuid)

Returns the user portal file with the given UUID.

Parameters:

uc - user context for database transactions.

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

fileUuid - UUID of the file to get.

Returns:

all user portal entities available for the given client.

Throws:

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

Since:

8.4.0

getForFrontendServer

PagedResult<UserPortal> getForFrontendServer(UserContext uc,
 FrontendServer frontendServer,
 int page,
 int pageSize)

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

Parameters:

uc - user 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(UserContext uc,
 int page,
 int pageSize)

Returns all user portal entities available on the master server.

Parameters:

uc - user 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.