Interface IFormsApi

public interface IFormsApi
High-level methods for interacting with portal forms.
Since:
8.2.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • byUuid

      IUserPortalResponse<DetailedFormResource> byUuid(IUserPortalInvocationContext ctx, UUID clientUuid, UUID formUuid)
      Reads a form by its UUID.
      Parameters:
      ctx - Invocation context for communicating with the user portal REST API.
      clientUuid - UUID of the client to read.
      formUuid - UUID of the form to read.
      Returns:
      The form with the given UUID, null if no such form exists.

    • getFormsPage

      IUserPortalResponse<FormResourcePage> getFormsPage(IUserPortalInvocationContext ctx, UUID userPortalUuid, PagingDataModel pagingDataModel, FormsQueryModel queryModel)
      Reads a page of forms 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 forms.
      pagingDataModel - Paging data for the forms to retrieve.
      queryModel - Query to filter forms by.
      Returns:
      A page of forms of the given portal.

    • getFormsCount

      IUserPortalResponse<Integer> getFormsCount(IUserPortalInvocationContext ctx, UUID userPortalUuid, FormsQueryModel queryModel)
      Reads the count of forms 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 forms.
      queryModel - Query to filter forms by.
      Returns:
      The count of forms of the given portal.

    • getAllTags

      IUserPortalResponse<List<FormTagResource>> 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.