com.files.models

Class FormFieldSet

java.lang.Object

com.files.models.FormFieldSet

All Implemented Interfaces:

ModelInterface

public class FormFieldSet
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Object[]	formFields Associated form fields
Long[]	formLayout Layout of the form
Long	id Form field set id
Boolean	skipCompany Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
Boolean	skipEmail Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
Boolean	skipName Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
String	title Title to be displayed
Long	userId User ID.

Constructor Summary

Constructors

Constructor and Description
FormFieldSet()
FormFieldSet(HashMap<String,Object> parameters)
FormFieldSet(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<FormFieldSet>	all()
static ListIterator<FormFieldSet>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static FormFieldSet	create(HashMap<String,Object> parameters) Parameters: user_id - int64 - User ID.
static FormFieldSet	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static FormFieldSet	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static FormFieldSet	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Form Field Set ID.
static FormFieldSet	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static FormFieldSet	get()
static FormFieldSet	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<FormFieldSet>	list() Parameters: user_id - int64 - User ID.
static ListIterator<FormFieldSet>	list(HashMap<String,Object> parameters)
static ListIterator<FormFieldSet>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
FormFieldSet	update() Parameters: title - string - Title to be displayed skip_email - boolean - Skip validating form email skip_name - boolean - Skip validating form name skip_company - boolean - Skip validating company form_fields - array(object)
static FormFieldSet	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static FormFieldSet	update(Long id, HashMap<String,Object> parameters) Parameters: title - string - Title to be displayed skip_email - boolean - Skip validating form email skip_name - boolean - Skip validating form name skip_company - boolean - Skip validating company form_fields - array(object)
static FormFieldSet	update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

Form field set id

title

public String title

Title to be displayed

formLayout

public Long[] formLayout

Layout of the form

formFields

public Object[] formFields

Associated form fields

skipName

public Boolean skipName

Any associated InboxRegistrations or BundleRegistrations can be saved without providing name

skipEmail

public Boolean skipEmail

Any associated InboxRegistrations or BundleRegistrations can be saved without providing email

skipCompany

public Boolean skipCompany

Any associated InboxRegistrations or BundleRegistrations can be saved without providing company

userId

public Long userId

User ID. Provide a value of `0` to operate the current session's user.

Constructor Detail

FormFieldSet

public FormFieldSet()

FormFieldSet

public FormFieldSet(HashMap<String,Object> parameters)

FormFieldSet

public FormFieldSet(HashMap<String,Object> parameters,
                    HashMap<String,Object> options)

Method Detail

update

public FormFieldSet update()
                    throws IOException

Parameters: title - string - Title to be displayed skip_email - boolean - Skip validating form email skip_name - boolean - Skip validating form name skip_company - boolean - Skip validating company form_fields - array(object)

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<FormFieldSet> list()
                                       throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Throws:

RuntimeException

list

public static ListIterator<FormFieldSet> list(HashMap<String,Object> parameters)
                                       throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<FormFieldSet> list(HashMap<String,Object> parameters,
                                              HashMap<String,Object> options)
                                       throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<FormFieldSet> all()
                                      throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<FormFieldSet> all(HashMap<String,Object> parameters,
                                             HashMap<String,Object> options)
                                      throws RuntimeException

Throws:

RuntimeException

find

public static FormFieldSet find(Long id,
                                HashMap<String,Object> parameters)
                         throws RuntimeException

Parameters: id (required) - int64 - Form Field Set ID.

Throws:

RuntimeException

find

public static FormFieldSet find(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

find

public static FormFieldSet find(Long id,
                                HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

get

public static FormFieldSet get()
                        throws RuntimeException

Throws:

RuntimeException

get

public static FormFieldSet get(Long id,
                               HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException

Throws:

RuntimeException

create

public static FormFieldSet create(HashMap<String,Object> parameters)
                           throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. title - string - Title to be displayed skip_email - boolean - Skip validating form email skip_name - boolean - Skip validating form name skip_company - boolean - Skip validating company form_fields - array(object)

Throws:

RuntimeException

create

public static FormFieldSet create(HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException

Throws:

RuntimeException

update

public static FormFieldSet update(Long id,
                                  HashMap<String,Object> parameters)
                           throws RuntimeException

Parameters: title - string - Title to be displayed skip_email - boolean - Skip validating form email skip_name - boolean - Skip validating form name skip_company - boolean - Skip validating company form_fields - array(object)

Throws:

RuntimeException

update

public static FormFieldSet update(HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException

Throws:

RuntimeException

update

public static FormFieldSet update(Long id,
                                  HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException