com.adobe.icc.services.api
Interface FragmentLayoutService

public interface FragmentLayoutService

Service interface for ContainerLayout specific operations.

Method Summary

FragmentLayout	copyFragmentLayout(String oldFragmentLayoutID, FragmentLayout newFragmentLayout) Create a copy of the FragmentLayout identified by the oldFragmentLayoutID.
FragmentLayout	createFragmentLayout(FragmentLayout fragmentLayout) Create a new FragmentLayout object.
Boolean	fragmentLayoutExists(String fragmentLayoutName) Check if a FragmentLayout exists by the given name.
List	getAllFragmentLayouts(Query query) List all FragmentLayouts filtered by the given Query.
List	getDependentLetters(String fragmentLayoutID) Retrieve the list of Letters dependent on the Form identified by the given FragmentLayoutID.
FragmentLayout	getFragmentLayout(String fragmentLayoutID) Fetch the FragmentLayout identified by the given FragmentLayoutID.
boolean	isReferenced(String fragmentLayoutID) Check if this FragmentLayout is being referenced by any other asset (Letter).
FragmentLayout	markReadyToPublish(String fragmentLayoutID) Mark as ready to publish the FragmentLayout identified by the given fragmentLayoutID.
FragmentLayout	parseFragmentLayout(FragmentLayout fragmentLayout) Parses fragment layout and populates target areas, fields and tables in it.
FragmentLayout	publishFragmentLayout(String fragmentLayoutID) Publish the FragmentLayout identified by the given FragmentLayoutID.
FragmentLayout	retrieveVersion(String fragmentLayoutId, Date publishDate) Returns the version of fragment layout that was published on or before the specified date.
FragmentLayout	revertToLastPublished(String fragmentLayoutId) Reverts the fragment layout to the last published version.
boolean	updateDependencies(FragmentLayout oldFragmentLayout, FragmentLayout newFragmentLayout) Update the references of the old FragmentLayout oldFragmentLayout, in any dependent assets, with the new FragmentLayout newFragmentLayout.
boolean	updateDependencies(FragmentLayout oldFragmentLayout, FragmentLayout newFragmentLayout, List clas, Map claMap) Update the references of the old FragmentLayout oldFragmentLayout, in any dependent assets, with the new FragmentLayout newFragmentLayout.
FragmentLayout	updateFragmentLayout(FragmentLayout fragmentLayout) Update the given FragmentLayout.

Method Detail

fragmentLayoutExists

Boolean fragmentLayoutExists(String fragmentLayoutName)
                             throws ICCException

Check if a FragmentLayout exists by the given name.

Parameters:

fragmentLayout - Name of the FragmentLayout.

Returns:

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

Throws:

ICCException

Since:

10.0.0

getAllFragmentLayouts

List getAllFragmentLayouts(Query query)
                           throws ICCException

List all FragmentLayouts filtered by the given Query.

Parameters:

query - Query to select FragmentLayouts (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 (FragmentLayout object, in this case).

Returns:

List of FragmentLayout objects

Throws:

ICCException

Since:

10.0.0.0

See Also:

Statement} and {@link Query}.

markReadyToPublish

FragmentLayout markReadyToPublish(String fragmentLayoutID)
                                  throws ICCException

Mark as ready to publish the FragmentLayout identified by the given fragmentLayoutID.

Parameters:

fragmentLayoutID - ID of the FragmentLayout.

Returns:

FragmentLayout object marked for publishing

Throws:

ICCException

Since:

10.0.0.0

publishFragmentLayout

FragmentLayout publishFragmentLayout(String fragmentLayoutID)
                                     throws ICCException

Publish the FragmentLayout identified by the given FragmentLayoutID.

Parameters:

fragmentLayoutID - ID of the FragmentLayout.

Returns:

published FragmentLayout object

Throws:

ICCException

Since:

10.0.0.0

getFragmentLayout

FragmentLayout getFragmentLayout(String fragmentLayoutID)
                                 throws ICCException

Fetch the FragmentLayout identified by the given FragmentLayoutID.

Parameters:

fragmentLayoutID - ID of the FragmentLayout to be fetched.

Returns:

the FragmentLayout identified by the given FragmentLayoutID.

Throws:

ICCException

Since:

10.0.0.0

createFragmentLayout

FragmentLayout createFragmentLayout(FragmentLayout fragmentLayout)
                                    throws ICCException

Create a new FragmentLayout object.

Parameters:

fragmentLayout - The FragmentLayout to be created.

Returns:

Created FragmentLayout object

Throws:

ICCException

Since:

10.0.0.0

updateFragmentLayout

FragmentLayout updateFragmentLayout(FragmentLayout fragmentLayout)
                                    throws ICCException

Update the given FragmentLayout.

Parameters:

fragmentLayout - FragmentLayout object to be updated.

Returns:

updated FragmentLayout object.

Throws:

ICCException

Since:

10.0.0.0

copyFragmentLayout

FragmentLayout copyFragmentLayout(String oldFragmentLayoutID,
                                  FragmentLayout newFragmentLayout)
                                  throws ICCException

Create a copy of the FragmentLayout identified by the oldFragmentLayoutID.

If the incoming FragmentLayout newFragmentLayout does not have content in it, the content of the original FragmentLayout is set in it.

Parameters:

oldFragmentLayoutID - ID of the original FragmentLayout. Used to fetch the original content, if need be.

newFragmentLayout - copy of the original FragmentLayout (may have properties altered by the user)

Returns:

Created copy of the FragmentLayout.

Throws:

ICCException

Since:

10.0.0.0

isReferenced

boolean isReferenced(String fragmentLayoutID)
                     throws ICCException

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

Parameters:

FragmentLayoutID - ID of the FragmentLayout whose dependencies are to be fetched.

Returns:

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

Throws:

ICCException

Since:

10.0.0.0

getDependentLetters

List getDependentLetters(String fragmentLayoutID)
                         throws ICCException

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

Parameters:

FragmentLayoutID - ID of the FragmentLayout whose dependencies are to be fetched.

Returns:

List of Letters which depend on the given FragmentLayout.

Throws:

ICCException

Since:

10.0.0.0

updateDependencies

boolean updateDependencies(FragmentLayout oldFragmentLayout,
                           FragmentLayout newFragmentLayout)
                           throws ICCException

Update the references of the old FragmentLayout oldFragmentLayout, in any dependent assets, with the new FragmentLayout newFragmentLayout.

Parameters:

oldFragmentLayout - The old FragmentLayout object.

newFragmentLayout - The new FragmentLayout object, which should be set as the new reference.

Returns:

True if the operation succeeds, False otherwise.

Throws:

ICCException

Since:

10.0.0.0

updateDependencies

boolean updateDependencies(FragmentLayout oldFragmentLayout,
                           FragmentLayout newFragmentLayout,
                           List clas,
                           Map claMap)
                           throws ICCException

Update the references of the old FragmentLayout oldFragmentLayout, in any dependent assets, with the new FragmentLayout newFragmentLayout.

Parameters:

oldFragmentLayout - The old FragmentLayout object.

newFragmentLayout - The new FragmentLayout object, which should be set as the new reference.

clas - List of container layout assignment that are required to be updated.

claMap - Map of container layout assignment and their parent letters.

Returns:

True if the operation succeeds, False otherwise.

Throws:

ICCException

Since:

10.0.0.0

parseFragmentLayout

FragmentLayout parseFragmentLayout(FragmentLayout fragmentLayout)
                                   throws ICCException

Parses fragment layout and populates target areas, fields and tables in it.

Parameters:

fragmentLayout - FragmentLayout required to be parsed

Returns:

FragmentLayout populated with target areas, fields and tables.

Throws:

ICCException

revertToLastPublished

FragmentLayout revertToLastPublished(String fragmentLayoutId)
                                     throws ICCException

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

Parameters:

fragmentLayoutId - The fragment layout ID.

Returns:

Reverted fragment layout.

Throws:

ICCException

Since:

10.0.0.0

retrieveVersion

FragmentLayout retrieveVersion(String fragmentLayoutId,
                               Date publishDate)

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

Parameters:

fragmentLayoutId - The FragmentLayout ID.

publishDate - specifies the date for fetching published FragmentLayout.

Returns:

version which was published on or before the specified date.

Throws:

ICCException

Since:

10.0.0.0