com.adobe.icc.services.api

Interface FragmentLayoutService

Deprecated.

@Deprecated
public interface FragmentLayoutService

Service interface for ContainerLayout specific operations.

Method Summary

Modifier and Type	Method and Description
FragmentLayout	copyFragmentLayout(String oldFragmentLayoutID, FragmentLayout newFragmentLayout) Deprecated.
FragmentLayout	createFragmentLayout(FragmentLayout fragmentLayout) Deprecated.
Boolean	fragmentLayoutExists(String fragmentLayoutName) Deprecated.
List<FragmentLayout>	getAllFragmentLayouts(Query query) Deprecated.
List<Letter>	getDependentLetters(String fragmentLayoutID) Deprecated. getDependentLetters(String, String, boolean) instead.
List<Letter>	getDependentLetters(String fragmentLayoutID, String cutPoints, boolean includeContent) Deprecated.
FragmentLayout	getFragmentLayout(String fragmentLayoutID) Deprecated.
boolean	isReferenced(String fragmentLayoutID) Deprecated.
FragmentLayout	parseFragmentLayout(FragmentLayout fragmentLayout) Deprecated.
FragmentLayout	publishFragmentLayout(String fragmentLayoutID) Deprecated. Since 6.2. Use PublishService.publishAssets(List) instead.
FragmentLayout	readFragmentLayout(String fragmentLayoutID) Deprecated.
FragmentLayout	retrieveVersion(String fragmentLayoutId, Date publishDate) Deprecated.
FragmentLayout	revertToLastPublished(String fragmentLayoutId) Deprecated. Use AssetService.revertToLastPublished(String) instead.
List<FragmentLayout>	searchFragmentsWithFMFragment(String fmFragmentLayoutPath) Deprecated.
boolean	updateDependencies(FragmentLayout oldFragmentLayout, FragmentLayout newFragmentLayout) Deprecated.
Set<Letter>	updateDependencies(FragmentLayout oldFragmentLayout, FragmentLayout newFragmentLayout, List<ContainerLayoutAssignment> clas, Map<ContainerLayoutAssignment,Letter> claMap) Deprecated. Update the references of the old FragmentLayout oldFragmentLayout, in given dependent assets, with the new FragmentLayout newFragmentLayout.
boolean	updateEffectiveDependencies(FragmentLayout oldFragmentLayout, FragmentLayout newFragmentLayout, List<String> lettersToBeIgnored) Deprecated.
FragmentLayout	updateFMFormInFragment(String fragmentId, String fmFormPath) Deprecated.
FragmentLayout	updateFragmentLayout(FragmentLayout fragmentLayout) Deprecated.

Method Detail

fragmentLayoutExists

@Deprecated
Boolean fragmentLayoutExists(String fragmentLayoutName)
                                  throws ICCException

Deprecated.

Check if a FragmentLayout exists by the given name.

Parameters:

fragmentLayoutName - Name of the FragmentLayout.

Returns:

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

Throws:

ICCException

Since:

10.0.0

getAllFragmentLayouts

@Deprecated
List<FragmentLayout> getAllFragmentLayouts(Query query)
                                                throws ICCException

Deprecated.

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, Query

searchFragmentsWithFMFragment

@Deprecated
List<FragmentLayout> searchFragmentsWithFMFragment(String fmFragmentLayoutPath)
                                                        throws ICCException

Deprecated.

List all FragmentLayouts which use the xdp at path fmFragmentLayoutPath.

Parameters:

fmFragmentLayoutPath - path of the XDP used in fragments.

Returns:

FragmentLayout objects

Throws:

ICCException

Since:

10.0.0.0

publishFragmentLayout

@Deprecated
FragmentLayout publishFragmentLayout(String fragmentLayoutID)
                                          throws ICCException

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

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

@Deprecated
FragmentLayout getFragmentLayout(String fragmentLayoutID)
                                      throws ICCException

Deprecated.

Fetch the FragmentLayout identified by the given FragmentLayoutID. This action is not audited for action type Read.

Parameters:

fragmentLayoutID - ID of the FragmentLayout to be fetched.

Returns:

the FragmentLayout identified by the given FragmentLayoutID.

Throws:

ICCException

Since:

10.0.0.0

readFragmentLayout

@Deprecated
FragmentLayout readFragmentLayout(String fragmentLayoutID)
                                       throws ICCException

Deprecated.

Fetch the FragmentLayout identified by the given FragmentLayoutID. This action is audited for action type Read.

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

@Deprecated
FragmentLayout createFragmentLayout(FragmentLayout fragmentLayout)
                                         throws ICCException

Deprecated.

Create a new FragmentLayout object.

Parameters:

fragmentLayout - The FragmentLayout to be created.

Returns:

Created FragmentLayout object

Throws:

ICCException

Since:

10.0.0.0

updateFMFormInFragment

@Deprecated
FragmentLayout updateFMFormInFragment(String fragmentId,
                                                  String fmFormPath)
                                           throws ICCException

Deprecated.

Update the given FragmentLayout Template.

Parameters:

fragmentId - id of object to be updated.

fmFormPath - path of fmForm to be updated.

Returns:

updated FragmentLayout object.

Throws:

ICCException

Since:

10.0.0.0

updateFragmentLayout

@Deprecated
FragmentLayout updateFragmentLayout(FragmentLayout fragmentLayout)
                                         throws ICCException

Deprecated.

Update the given FragmentLayout.

Parameters:

fragmentLayout - FragmentLayout object to be updated.

Returns:

updated FragmentLayout object.

Throws:

ICCException

Since:

10.0.0.0

copyFragmentLayout

@Deprecated
FragmentLayout copyFragmentLayout(String oldFragmentLayoutID,
                                              FragmentLayout newFragmentLayout)
                                       throws ICCException

Deprecated.

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

@Deprecated
boolean isReferenced(String fragmentLayoutID)
                          throws ICCException

Deprecated.

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

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

Deprecated. getDependentLetters(String, String, boolean) instead.

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

getDependentLetters

@Deprecated
List<Letter> getDependentLetters(String fragmentLayoutID,
                                             String cutPoints,
                                             boolean includeContent)
                                      throws ICCException

Deprecated.

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

Parameters:

cutPoints - cut points to be fetched for dependent letters. If null, letter association cut points will be used

includeContent - Whether to include binaries or not?

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

@Deprecated
boolean updateDependencies(FragmentLayout oldFragmentLayout,
                                       FragmentLayout newFragmentLayout)
                                throws ICCException

Deprecated.

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

updateEffectiveDependencies

@Deprecated
boolean updateEffectiveDependencies(FragmentLayout oldFragmentLayout,
                                                FragmentLayout newFragmentLayout,
                                                List<String> lettersToBeIgnored)
                                         throws ICCException

Deprecated.

Update the references of the old FragmentLayout oldFragmentLayout, in any dependent assets, with the new FragmentLayout newFragmentLayout. The list of Letters names which are passed in the third parameter are ignored.

Parameters:

oldFragmentLayout - The old FragmentLayout object.

newFragmentLayout - The new FragmentLayout 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

Since:

10.0.0.0

updateDependencies

Set<Letter> updateDependencies(FragmentLayout oldFragmentLayout,
                               FragmentLayout newFragmentLayout,
                               List<ContainerLayoutAssignment> clas,
                               Map<ContainerLayoutAssignment,Letter> claMap)
                        throws ICCException

Deprecated.

Update the references of the old FragmentLayout oldFragmentLayout, in given 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:

set containing updated letters.

Throws:

ICCException

Since:

10.0.0.0

parseFragmentLayout

@Deprecated
FragmentLayout parseFragmentLayout(FragmentLayout fragmentLayout)
                                        throws ICCException

Deprecated.

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

@Deprecated
FragmentLayout revertToLastPublished(String fragmentLayoutId)
                                          throws ICCException

Deprecated. Use AssetService.revertToLastPublished(String) instead.

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

@Deprecated
FragmentLayout retrieveVersion(String fragmentLayoutId,
                                           Date publishDate)

Deprecated.

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