com.adobe.icc.services.api

Interface FormService

Deprecated.

@Deprecated
public interface FormService

Service interface for Form specific operations.

Method Summary

Modifier and Type	Method and Description
Form	activateForm(String formID, boolean updateDependencies) Deprecated.
Form	copyForm(String oldformID, Form newform) Deprecated.
Form	createForm(Form form) Deprecated.
Form	createTestForm(String formID) Deprecated.
Boolean	formExists(String formName) Deprecated.
List<Form>	getAllForms(Query query) Deprecated.
List<Letter>	getDependentLetters(String formID) Deprecated.
Form	getForm(String formID) Deprecated.
boolean	isReferenced(String formID) Deprecated.
Form	publishForm(String formID) Deprecated. Since 6.2. Use PublishService.publishAssets(List) instead.
Form	readForm(String formID) Deprecated.
Form	retrieveVersion(String formId, Date publishDate) Deprecated.
Form	revertToLastPublished(String formId) Deprecated. Use AssetService.revertToLastPublished(String) instead.
Form	searchFormWithFMLayout(String formID) Deprecated.
boolean	updateDependencies(Form oldForm, Form newForm) Deprecated.
Set<Letter>	updateDependencies(Form oldForm, Form newForm, List<Letter> letters) Deprecated.
boolean	updateEffectiveDependencies(Form oldForm, Form newForm, List<String> lettersToBeIgnored) Deprecated.
Form	updateForm(Form form) Deprecated.

Method Detail

formExists

@Deprecated
Boolean formExists(String formName)
                        throws ICCException

Deprecated.

Check if a Form exists by the given name.

Parameters:

formName - Name of the form.

Returns:

True if a Form exists by the given name, False otherwise

Throws:

ICCException

getAllForms

@Deprecated
List<Form> getAllForms(Query query)
                            throws ICCException

Deprecated.

List all Forms filtered by the given Query.

Parameters:

query - Query to select Forms (supports only first level attributes/properties of an object).
The "attributeName" used in the Statement object should be the name of the property in the object (Form object, in this case).

Returns:

List of Form objects

Throws:

ICCException

See Also:

Statement, Query

createTestForm

@Deprecated
Form createTestForm(String formID)
                         throws ICCException

Deprecated.

Create a Test/Inactive version of the Form object.

Parameters:

formID - ID of Form whose test/inactive version is to be created.

Returns:

The created test/inactive version of the Form object.

Throws:

ICCException

getDependentLetters

@Deprecated
List<Letter> getDependentLetters(String formID)
                                      throws ICCException

Deprecated.

Retrieve the list of Letters dependent on the Form identified by the given formID.

Parameters:

formID - ID of the Form whose dependencies are to be fetched.

Returns:

List of Letters which depend on the given Form.

Throws:

ICCException

activateForm

@Deprecated
Form activateForm(String formID,
                              boolean updateDependencies)
                       throws ICCException

Deprecated.

Activate the Form identified by the given formID.

Parameters:

formID - ID of the Form.

updateDependencies - Whether to set this new activated version in the dependencies.

Returns:

activated Form object

Throws:

ICCException

publishForm

@Deprecated
Form publishForm(String formID)
                      throws ICCException

Deprecated. Since 6.2. Use PublishService.publishAssets(List) instead.

Publish the Form identified by the given formID.

Parameters:

formID - ID of the Form.

Returns:

published Form object

Throws:

ICCException

Since:

10.0.0.0

getForm

@Deprecated
Form getForm(String formID)
                  throws ICCException

Deprecated.

Fetch the Form identified by the given formID. This action is not audited for action type Read.

Parameters:

formID - ID of the Form to be fetched.

Returns:

the Form identified by the given formID.

Throws:

ICCException

searchFormWithFMLayout

@Deprecated
Form searchFormWithFMLayout(String formID)
                                 throws ICCException

Deprecated.

Fetch the Form identified by the given formID. This action is not audited for action type Read.

Parameters:

formID - ID of the Form to be fetched.

Returns:

the Form identified by the given formID.

Throws:

ICCException

readForm

@Deprecated
Form readForm(String formID)
                   throws ICCException

Deprecated.

Fetch the Form identified by the given formID. This action is audited for action type Read.

Parameters:

formID - ID of the Form to be fetched.

Returns:

the Form identified by the given formID.

Throws:

ICCException

createForm

@Deprecated
Form createForm(Form form)
                     throws ICCException

Deprecated.

Create a new Form object.

Parameters:

form - The Form to be created.

Returns:

Created Form object

Throws:

ICCException

updateForm

@Deprecated
Form updateForm(Form form)
                     throws ICCException

Deprecated.

Update the given Form.

Parameters:

form - Form object to be updated.

Returns:

updated Form object.

Throws:

ICCException

copyForm

@Deprecated
Form copyForm(String oldformID,
                          Form newform)
                   throws ICCException

Deprecated.

Create a copy of the Form identified by the oldformID.

If the incoming Form newform does not have content in it, the content of the original Form is set in it.

Parameters:

oldformID - ID of the original Form. Used to fetch the original content, if need be.

newform - copy of the original Form (may have properties altered by the user)

Returns:

Created copy of the Form.

Throws:

ICCException

isReferenced

@Deprecated
boolean isReferenced(String formID)
                          throws ICCException

Deprecated.

Check if this Form is being referenced by any other asset (Letter).

Parameters:

formID - ID of the Form whose dependencies are to be fetched.

Returns:

True, if the Form is being referenced, False otherwise.

Throws:

ICCException

updateDependencies

@Deprecated
boolean updateDependencies(Form oldForm,
                                       Form newForm)
                                throws ICCException

Deprecated.

Update the references of the old Form oldForm, in any dependent assets, with the new Form newForm.

Parameters:

oldForm - The old Form object.

newForm - The new Form object, which should be set as the new reference.

Returns:

True if the operation succeeds, False otherwise.

Throws:

ICCException

updateEffectiveDependencies

@Deprecated
boolean updateEffectiveDependencies(Form oldForm,
                                                Form newForm,
                                                List<String> lettersToBeIgnored)
                                         throws ICCException

Deprecated.

Update the references of the old Form oldForm, in any dependent assets, with the new Form newForm. The list of Letters names which are passed in the third parameter are ignored.

Parameters:

oldForm - The old Form object.

newForm - The new Form object, which should be set as the new reference.

lettersToBeIgnored - List of Letter Names which are to be ignored while updating the dependent Letters.

Returns:

True if the operation succeeds, False otherwise.

Throws:

ICCException

updateDependencies

@Deprecated
Set<Letter> updateDependencies(Form oldForm,
                                           Form newForm,
                                           List<Letter> letters)
                                    throws ICCException

Deprecated.

Update the references of the old Form oldForm, in given dependent assets (passed as third parameter), with the new Form newForm.

Parameters:

oldForm - The old Form object.

newForm - The new Form object, which should be set as the new reference.

letters - List of letters which are required to be updated.

Returns:

set containing updated letters.

Throws:

ICCException

Since:

10.0.0.0

revertToLastPublished

@Deprecated
Form revertToLastPublished(String formId)
                                throws ICCException

Deprecated. Use AssetService.revertToLastPublished(String) instead.

Reverts the form to the last published version. If form is not published, it is removed from repository.

Parameters:

formId - The Form ID.

Returns:

Reverted form.

Throws:

ICCException

Since:

10.0.0.0

retrieveVersion

@Deprecated
Form retrieveVersion(String formId,
                                 Date publishDate)

Deprecated.

Returns the version of form that was published on or before the specified date.

Parameters:

formId - The Form ID.

publishDate - specifies the date for fetching published form.

Returns:

version which was published on or before the specified date.

Throws:

ICCException

Since:

10.0.0.0