Package de.xima.fc.user_portal.api.provider.spec

Interface IUserPortalContentsApi

All Known Implementing Classes:

UserPortalContentApiImpl

public interface IUserPortalContentsApi

High-level methods for interacting with portal contents.

Since:

8.6.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IUserPortalResponse<BaseUserPortalContentResource>	byUuid(IUserPortalInvocationContext ctx, UUID userPortalUuid, UUID userPortalContentUuid)	Reads a content by its UUID.
IUserPortalResponse<List<BaseUserPortalContentTagResource>>	getAllTags(IUserPortalInvocationContext ctx, UUID userPortalUuid)	Reads all tags of a given portal.
IUserPortalResponse<Integer>	getUserPortalContentsCount(IUserPortalInvocationContext ctx, UUID userPortalUuid, UserPortalContentsQueryModel queryModel)	Reads the count of contents of a given portal.
IUserPortalResponse<BaseUserPortalContentResourcePage>	getUserPortalContentsPage(IUserPortalInvocationContext ctx, UUID userPortalUuid, PagingDataModel pagingDataModel, UserPortalContentsQueryModel queryModel)	Reads a page of contents of a given portal.

Method Detail

byUuid

IUserPortalResponse<BaseUserPortalContentResource> byUuid(IUserPortalInvocationContext ctx,
                                                          UUID userPortalUuid,
                                                          UUID userPortalContentUuid)

Reads a content by its UUID.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

userPortalUuid - UUID of the user portal to read.

userPortalContentUuid - UUID of the user portal content to read.

Returns:

The form with the given UUID, null if no such form exists.

getUserPortalContentsPage

IUserPortalResponse<BaseUserPortalContentResourcePage> getUserPortalContentsPage(IUserPortalInvocationContext ctx,
                                                                                 UUID userPortalUuid,
                                                                                 PagingDataModel pagingDataModel,
                                                                                 UserPortalContentsQueryModel queryModel)

Reads a page of contents of a given portal.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

userPortalUuid - UUID of the user portal for which to retrieve contents.

pagingDataModel - Paging data for the contents to retrieve.

queryModel - Query to filter contents by.

Returns:

A page of contents of the given portal.

getUserPortalContentsCount

IUserPortalResponse<Integer> getUserPortalContentsCount(IUserPortalInvocationContext ctx,
                                                        UUID userPortalUuid,
                                                        UserPortalContentsQueryModel queryModel)

Reads the count of contents of a given portal.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

userPortalUuid - UUID of the user portal for which to retrieve contents.

queryModel - Query to filter contents by.

Returns:

The count of contents of the given portal.

getAllTags

IUserPortalResponse<List<BaseUserPortalContentTagResource>> getAllTags(IUserPortalInvocationContext ctx,
                                                                       UUID userPortalUuid)

Reads all tags of a given portal.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

userPortalUuid - UUID of the user portal for which to retrieve tags.

Returns:

A list of tags of the given portal.