Package de.xima.fc.handler.entity

Class UserPortalContentHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.UserPortalContentHandler

All Implemented Interfaces:

IAPIHandler, IGenericHandler, IUserPortalContentHandler, Serializable

public class UserPortalContentHandler
extends GenericHandler
implements IUserPortalContentHandler

Entity handler for user portal contents.

Since:

8.6.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields inherited from class de.xima.fc.handler.entity.GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
UserPortalContentHandler()

Method Summary

Modifier and Type	Method	Description
UserPortalContent	getByUserPortalUuid(UserContext uc, UUID userPortalUuid, UUID userPortalContentUuid, Long frontendServerId)	Get a user portal content by its UUID within a user portal.
BaseUserPortalContentDTO	getByUserPortalUuid(UserContext uc, UUID userPortalUuid, UUID userPortalContentUuid, Long frontendServerId, Locale locale)	Get a user portal content by its UUID within a user portal.
PagedResult<BaseUserPortalContentDTO>	getUserPortalContents(UserContext uc, PageQuery page, UserPortalContentsPageQuery query, boolean skipCount)	Get paged user portal contents matching the given filter.

Methods inherited from class de.xima.fc.handler.entity.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 de.xima.fc.handler.AMSApiHandler

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

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

Constructor Detail

UserPortalContentHandler

public UserPortalContentHandler()

Method Detail

getUserPortalContents

public PagedResult<BaseUserPortalContentDTO> getUserPortalContents(UserContext uc,
                                                                   PageQuery page,
                                                                   UserPortalContentsPageQuery query,
                                                                   boolean skipCount)

Description copied from interface: IUserPortalContentHandler

Get paged user portal contents matching the given filter.

Specified by:

getUserPortalContents in interface IUserPortalContentHandler

Parameters:

uc - User context

page - the page query

query - the filter

skipCount - whether to skip counting total results

Returns:

the paged result of user portal content DTOs

getByUserPortalUuid

public BaseUserPortalContentDTO getByUserPortalUuid(UserContext uc,
                                                    UUID userPortalUuid,
                                                    UUID userPortalContentUuid,
                                                    Long frontendServerId,
                                                    Locale locale)

Description copied from interface: IUserPortalContentHandler

Get a user portal content by its UUID within a user portal.

Specified by:

getByUserPortalUuid in interface IUserPortalContentHandler

Parameters:

uc - User context

userPortalUuid - the user portal UUID

userPortalContentUuid - the user portal content UUID

frontendServerId - The ID of the frontend server. Can be null. Required for user portal content representing forms, as forms may not be available on all frontend servers.

locale - the locale

Returns:

the user portal content DTO

getByUserPortalUuid

public UserPortalContent getByUserPortalUuid(UserContext uc,
                                             UUID userPortalUuid,
                                             UUID userPortalContentUuid,
                                             Long frontendServerId)

Description copied from interface: IUserPortalContentHandler

Get a user portal content by its UUID within a user portal.

Specified by:

getByUserPortalUuid in interface IUserPortalContentHandler

Parameters:

uc - User context

userPortalUuid - the user portal UUID

userPortalContentUuid - the user portal content UUID

frontendServerId - The ID of the frontend server. Can be null. Required for user portal content representing forms, as forms may not be available on all frontend servers.

Returns:

the user portal content