Class UserPortalHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.UserPortalHandler

All Implemented Interfaces:

IAPIHandler, IGenericHandler, IUserPortalHandler, Serializable

public class UserPortalHandler
extends GenericHandler
implements IUserPortalHandler

Handler implementation for reading and writing UserPortal entities.

Since:

8.2.0

Author:

XIMA Media GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
UserPortalHandler()

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 class GenericHandler

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

Methods inherited from class AMSApiHandler

getName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Details

UserPortalHandler

public UserPortalHandler()

Method Details

getByAlias

public UserPortal getByAlias(UserContext uc,
 String alias)

Description copied from interface: IUserPortalHandler

Returns the user portal with the given alias.

Specified by:

getByAlias in interface IUserPortalHandler

Parameters:

uc - user context for database transactions.

alias - of the user portal.

Returns:

the user portal with the given alias or null.

getByName

public UserPortal getByName(UserContext uc,
 String name)

Description copied from interface: IUserPortalHandler

Returns the user portal with the given name.

Specified by:

getByName in interface IUserPortalHandler

Parameters:

uc - user context for database transactions.

name - of the user portal.

Returns:

the user portal with the given name or null.

getByUuid

public UserPortal getByUuid(UserContext uc,
 UUID uuid)

Description copied from interface: IUserPortalHandler

Returns the user portal with the given UUID.

Specified by:

getByUuid in interface IUserPortalHandler

Parameters:

uc - user context for database transactions.

uuid - of the user portal.

Returns:

the user portal with the given UUID or null.

getFileByUuid

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

Description copied from interface: IUserPortalHandler

Returns the user portal file with the given UUID.

Specified by:

getFileByUuid in interface IUserPortalHandler

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.

getForFrontendServer

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

Description copied from interface: IUserPortalHandler

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

Specified by:

getForFrontendServer in interface IUserPortalHandler

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

public PagedResult<UserPortal> getForMasterServer(UserContext uc,
 int page,
 int pageSize)

Description copied from interface: IUserPortalHandler

Returns all user portal entities available on the master server.

Specified by:

getForMasterServer in interface IUserPortalHandler

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.