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

Interface IFormsApi

public interface IFormsApi

High-level methods for interacting with portal forms.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormResource>>	allByPortal(IUserPortalInvocationContext ctx, de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalResource portal)	Reads all forms of a given portal.
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormResource>>	allByPortal(IUserPortalInvocationContext ctx, UUID portalUuid)	Reads all forms of a given portal.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormResource>	byUuid(IUserPortalInvocationContext ctx, UUID portalUuid, UUID clientUuid, UUID formUuid)	Reads a form by its UUID.

Method Detail

allByPortal

IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormResource>> allByPortal(IUserPortalInvocationContext ctx,
                                                                                                               de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalResource portal)

Reads all forms of a given portal.

Parameters:

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

portal - Portal to read forms from.

Returns:

A list of forms of the given portal.

allByPortal

IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormResource>> allByPortal(IUserPortalInvocationContext ctx,
                                                                                                               UUID portalUuid)

Reads all forms of a given portal.

Parameters:

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

portalUuid - UUID of the portal to read forms from.

Returns:

A list of forms of the given portal.

byUuid

IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormResource> byUuid(IUserPortalInvocationContext ctx,
                                                                                                    UUID portalUuid,
                                                                                                    UUID clientUuid,
                                                                                                    UUID formUuid)

Reads a form by its UUID.

Parameters:

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

portalUuid - UUID of the portal as context for the form.

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.