com.adobe.icc.services.api
Interface FormService

public interface FormService

Service interface for Form specific operations.

Method Summary

Form	activateForm(String formID, boolean updateDependencies) Deprecated.
Form	copyForm(String oldformID, Form newform) Create a copy of the Form identified by the oldformID.
Form	createForm(Form form) Create a new Form object.
Form	createTestForm(String formID) Deprecated.
void	deleteForm(String formID) Deprecated.
Boolean	formExists(String formName) Check if a Form exists by the given name.
List	getAllForms(Query query) List all Forms filtered by the given Query.
List	getDependentLetters(String formID) Retrieve the list of Letters dependent on the Form identified by the given formID.
Form	getForm(String formID) Fetch the Form identified by the given formID.
boolean	isReferenced(String formID) Check if this Form is being referenced by any other asset (Letter).
Form	markReadyToPublish(String formID) Mark as ready to publish the Form identified by the given formID.
Form	publishForm(String formID) Publish the Form identified by the given formID.
Form	retrieveVersion(String formId, Date publishDate) Returns the version of form that was published on or before the specified date.
Form	revertToLastPublished(String formId) Reverts the form to the last published version.
boolean	updateDependencies(Form oldForm, Form newForm) Update the references of the old Form oldForm, in any dependent assets, with the new Form newForm.
boolean	updateDependencies(Form oldForm, Form newForm, List letters) Update the references of the old Form oldForm, in any dependent assets (passed as third parameter), with the new Form newForm.
Form	updateForm(Form form) Update the given Form.

Method Detail

formExists

Boolean formExists(String formName)
                   throws ICCException

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

List getAllForms(Query query)
                 throws ICCException

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} and {@link Query}.

createTestForm

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

deleteForm

void deleteForm(String formID)
                throws ICCException

Deprecated.

Delete the Form object identified by the given formID.

Parameters:

formID - ID of the Form to be deleted.

Throws:

ICCException

getDependentLetters

List getDependentLetters(String formID)
                         throws ICCException

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

markReadyToPublish

Form markReadyToPublish(String formID)
                        throws ICCException

Mark as ready to publish the Form identified by the given formID.

Parameters:

formID - ID of the Form.

Returns:

Form object marked for publishing

Throws:

ICCException

Since:

10.0.0.0

activateForm

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

Form publishForm(String formID)
                 throws ICCException

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

Form getForm(String formID)
             throws ICCException

Fetch the Form identified by the given formID.

Parameters:

formID - ID of the Form to be fetched.

Returns:

the Form identified by the given formID.

Throws:

ICCException

createForm

Form createForm(Form form)
                throws ICCException

Create a new Form object.

Parameters:

form - The Form to be created.

Returns:

Created Form object

Throws:

ICCException

updateForm

Form updateForm(Form form)
                throws ICCException

Update the given Form.

Parameters:

form - Form object to be updated.

Returns:

updated Form object.

Throws:

ICCException

copyForm

Form copyForm(String oldformID,
              Form newform)
              throws ICCException

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

boolean isReferenced(String formID)
                     throws ICCException

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

boolean updateDependencies(Form oldForm,
                           Form newForm)
                           throws ICCException

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

updateDependencies

boolean updateDependencies(Form oldForm,
                           Form newForm,
                           List letters)
                           throws ICCException

Update the references of the old Form oldForm, in any 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:

True if the operation succeeds, False otherwise.

Throws:

ICCException

Since:

10.0.0.0

revertToLastPublished

Form revertToLastPublished(String formId)
                           throws ICCException

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

Form retrieveVersion(String formId,
                     Date publishDate)

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