Package de.xima.fc.handler.interfaces.entity

Interface IUserPortalContentHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

UserPortalContentHandler

public interface IUserPortalContentHandler
extends IGenericHandler

Since:

8.6.0

Author:

XIMA MEDIA GmbH

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 filter, boolean skipCount)	Get paged user portal contents matching the given filter.

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

Method Detail

getUserPortalContents

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

Get paged user portal contents matching the given filter.

Parameters:

uc - User context

page - the page query

filter - the filter

skipCount - whether to skip counting total results

Returns:

the paged result of user portal content DTOs

getByUserPortalUuid

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

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

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

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

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

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