FormVariantService Class Reference

Provides methods to return information related to forms More...

Public Member Functions
VariantIdentity	AddFormVariant (string sessionId, string formVariantName, string formName, string formVariantDescription, FormVariantElements formElements)
	Adds the new Form Variant and returns the identity of the form variant. More...
void	DeleteFormVariant (string sessionId, string formVariantName, string formName)
	Deletes all the versions of the specifed form Variant for the given form. More...
FormElements	GetFormElements (string sessionId, string formName)
	Gets the list of UI elements of the form.This includes the form elements of desktop, tablet and mobile forms. More...
FormVariant	GetFormVariant (string sessionId, string formVariantName, string formName)
	Gets the form variant. More...
VariantSummaryCollection	GetFormVariants (string sessionId, string formName)
	Gets the list of form variants associated with the given form. More...
void	UpdateFormVariant (string sessionId, string formVariantName, string formName, string newFormVariantName, string formVariantDescription, FormVariantElements formElements)
	Updates the form variant.It overwrites the xml of existing form variants with the specified form variant elements. More...

Description

Provides methods to return information related to forms

Member Functions

VariantIdentity AddFormVariant	(	string	sessionId,
		string	formVariantName,
		string	formName,
		string	formVariantDescription,
		FormVariantElements	formElements
	)

Adds the new Form Variant and returns the identity of the form variant.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
formVariantName	Name of the form variant. Cannot be null.
formName	Name of the form. Cannot be null
formVariantDescription	The form variant description. Can be null.
formElements	The FormVariantElements class. Cannot be null. FormVariantElements class contains collections of Desktop, Tablet and Mobile form variant elements which are of type FormVariantElementCollection. FormVariantElementCollection class is collection of FormVariantElement objects. FormVariant Element class has following members. Name Type Comment Name string The name of the form element to which the form variant has to be applied. LabelText string The label text of the form element which the user wants to set using the form variant.The Labeltext is empty if it is not used. State short The state of the form element which the user wants to set using the form variant.

Returns

Returns a VariantIdentity object. This contains the Identity of Added FormVariant.

Name	Type	Comment
Id	String	The id of variant.
Name	String	The name of variant.
version	Version	The version of variant.

Remarks

Form Elements cannot be created for a capture form.

Security

Resource must have access permission to the Designer ACL.

void DeleteFormVariant	(	string	sessionId,
		string	formVariantName,
		string	formName
	)

Deletes all the versions of the specifed form Variant for the given form.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
formVariantName	Name of the form variant. Cannot be null.
formName	Name of the form. Cannot be null.

Security

Resource must have access permission to the Designer ACL.

FormElements GetFormElements	(	string	sessionId,
		string	formName
	)

Gets the list of UI elements of the form.This includes the form elements of desktop, tablet and mobile forms.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
formName	Name of the form. Cannot be null.

Returns

Returns a FormElements object which contains collections of all the elements of all the formfactors.FormElements class contains the Collections of Desktop, tablet and mobile form elements which are of type FormElementCollection.FormElementCollection class is collection of FormElement objects. FormElement class contains the following members:

Name	Type	Comment
Name	string	The name of the form element to which the form variant has to be applied.

Remarks

Form Elements cannot be returned for a capture and MFP form.

Security

Resource must have access permission to the Designer ACL.

FormVariant GetFormVariant	(	string	sessionId,
		string	formVariantName,
		string	formName
	)

Gets the form variant.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
formVariantName	Name of the form variant. Cannot be null.
formName	Name of the form. Cannot be null.

Returns

Returns a FormVariant object. This contains the information of the given form variant associated with specified form.

Name	Type	Comment
VariantIdentity	VariantIdentity	The identity of the given form variant.
Description	string	The description of the given form variant.
FormIdentity	FormIdentity	The identity of the the specified form.
FormElements	FormElements	The desktop,table, phone form elements of the form variant.
LockedBy	ResourceIdentity	The identity of the resource which has locked the form variant.

Security

Resource must have access permission to the Designer ACL.

VariantSummaryCollection GetFormVariants	(	string	sessionId,
		string	formName
	)

Gets the list of form variants associated with the given form.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
formName	Name of the form. Cannot be null.

Returns

Returns a VariantSummaryCollection object. This contains the collection of form variants associated with given form.

Name	Type	Comment
VariantIdentity	VariantIdentity	The identity of the variant.
LockedBy	ResourceIdentity	The identity of the resource which has locked the form variant.

Security

Resource must have access permission to the Designer ACL.

void UpdateFormVariant	(	string	sessionId,
		string	formVariantName,
		string	formName,
		string	newFormVariantName,
		string	formVariantDescription,
		FormVariantElements	formElements
	)

Updates the form variant.It overwrites the xml of existing form variants with the specified form variant elements.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
formVariantName	Name of the form variant. Cannot be null.
formName	Name of the form. Cannot be null.
newFormVariantName	New name of the form variant. Can be null.
formVariantDescription	The form variant description. Can be null.
formElements	The FormVariantElements class. Can be null. FormVariantElements class contains collections of Desktop, Tablet and Mobile form variant elements which are of type FormVariantElementCollection. FormVariantElementCollection class is collection of FormVariantElement objects. FormVariantElement class has following members. Name Type Comment Name string The name of the form element to which the form variant has to be applied. LabelText string The label text of the form element which the user wants to set using the form variant.The label text is empty if it is not used. State short The state of the form element which the user wants to set using the form variant.

Security

Resource must have access permission to the Designer ACL.