|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FormService
Service interface for Form
specific operations.
Method Summary | |
---|---|
Form |
activateForm(java.lang.String formID,
boolean updateDependencies)
Deprecated. |
Form |
copyForm(java.lang.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(java.lang.String formID)
Deprecated. |
void |
deleteForm(java.lang.String formID)
Deprecated. |
java.lang.Boolean |
formExists(java.lang.String formName)
Check if a Form exists by the given name. |
java.util.List |
getAllForms(Query query)
List all Form s filtered by the given Query . |
java.util.List |
getDependentLetters(java.lang.String formID)
Retrieve the list of Letter s dependent on the Form identified by the given
formID . |
Form |
getForm(java.lang.String formID)
Fetch the Form identified by the given formID . |
boolean |
isReferenced(java.lang.String formID)
Check if this Form is being referenced by any other asset (Letter). |
Form |
markReadyToPublish(java.lang.String formID)
Mark as ready to publish the Form identified by the given formID . |
Form |
publishForm(java.lang.String formID)
Publish the Form identified by the given formID . |
Form |
readForm(java.lang.String formID)
Fetch the Form identified by the given formID . |
Form |
retrieveVersion(java.lang.String formId,
java.util.Date publishDate)
Returns the version of form that was published on or before the specified date. |
Form |
revertToLastPublished(java.lang.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 . |
java.util.Set |
updateDependencies(Form oldForm,
Form newForm,
java.util.List letters)
Update the references of the old Form oldForm , in given dependent assets (passed as third parameter),
with the new Form newForm . |
boolean |
updateEffectiveDependencies(Form oldForm,
Form newForm,
java.util.List lettersToBeIgnored)
Update the references of the old Form oldForm , in any dependent assets,
with the new Form newForm . |
Form |
updateForm(Form form)
Update the given Form . |
Method Detail |
---|
java.lang.Boolean formExists(java.lang.String formName) throws ICCException
formName
- Name of the form.
ICCException
java.util.List getAllForms(Query query) throws ICCException
Form
s filtered by the given Query
.
query
- Query to select Forms (supports only first level
attributes/properties of an object).Form
objects
ICCException
Statement
,
Query
Form createTestForm(java.lang.String formID) throws ICCException
Form
object.
formID
- ID of Form whose test/inactive version is to be created.
ICCException
void deleteForm(java.lang.String formID) throws ICCException
Form
object identified by the given formID
.
formID
- ID of the Form to be deleted.
ICCException
java.util.List getDependentLetters(java.lang.String formID) throws ICCException
Letter
s dependent on the Form
identified by the given
formID
.
formID
- ID of the Form
whose dependencies are to be fetched.
Letter
s which depend on the given Form
.
ICCException
Form markReadyToPublish(java.lang.String formID) throws ICCException
Form
identified by the given formID
.
formID
- ID of the Form
.
Form
object marked for publishing
ICCException
Form activateForm(java.lang.String formID, boolean updateDependencies) throws ICCException
Form
identified by the given formID
.
formID
- ID of the Form
.updateDependencies
- Whether to set this new activated version in the dependencies.
Form
object
ICCException
Form publishForm(java.lang.String formID) throws ICCException
Form
identified by the given formID
.
formID
- ID of the Form
.
Form
object
ICCException
Form getForm(java.lang.String formID) throws ICCException
Form
identified by the given formID
.
This action is not audited for action type Read.
formID
- ID of the Form
to be fetched.
Form
identified by the given formID
.
ICCException
Form readForm(java.lang.String formID) throws ICCException
Form
identified by the given formID
.
This action is audited for action type Read.
formID
- ID of the Form
to be fetched.
Form
identified by the given formID
.
ICCException
Form createForm(Form form) throws ICCException
Form
object.
form
- The Form
to be created.
Form
object
ICCException
Form updateForm(Form form) throws ICCException
Form
.
form
- Form
object to be updated.
Form
object.
ICCException
Form copyForm(java.lang.String oldformID, Form newform) throws ICCException
Form
identified by the oldformID
.
newform
does not have content in it, the content of the original Form
is set in it.
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)
Form
.
ICCException
boolean isReferenced(java.lang.String formID) throws ICCException
formID
- ID of the Form
whose dependencies are to be fetched.
ICCException
boolean updateDependencies(Form oldForm, Form newForm) throws ICCException
oldForm
, in any dependent assets,
with the new Form newForm
.
oldForm
- The old Form object.newForm
- The new Form object, which should be set as the new reference.
ICCException
boolean updateEffectiveDependencies(Form oldForm, Form newForm, java.util.List lettersToBeIgnored) throws ICCException
oldForm
, in any dependent assets,
with the new Form newForm
. The list of Letters names which are passed in the third parameter are ignored.
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.
ICCException
java.util.Set updateDependencies(Form oldForm, Form newForm, java.util.List letters) throws ICCException
oldForm
, in given dependent assets (passed as third parameter),
with the new Form newForm
.
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.
ICCException
Form revertToLastPublished(java.lang.String formId) throws ICCException
formId
- The Form ID.
ICCException
Form retrieveVersion(java.lang.String formId, java.util.Date publishDate)
formId
- The Form ID.publishDate
- specifies the date for fetching published form.
ICCException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |