Package com.adobe.cq.wcm.launches.cf

Interface ContentFragmentLaunchManager

All Superinterfaces:

LaunchManager

@ProviderType
public interface ContentFragmentLaunchManager
extends LaunchManager

Content fragment manager to perform operations like rebasing / getting differences between production and launch / promoting to production / deleting to a launch and to the resource contained inside.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.launches.api.LaunchManager

LaunchManager.CreateOptions

Method Summary

Modifier and Type	Method	Description
Resource	copyResource(Resource srcResource, java.lang.String destinationResourcePath, java.lang.String dstTitle)	Copies a resource to a new destination inside a Launch.
java.util.List<Resource>	createLaunchContentResources(java.util.List<LaunchSource> inputLaunchResourceList, Resource launchPageResource, Page launchPage)	Creates content resources inside the Content Fragment Launch.
void	deleteResource(Resource resource)	Deletes a resource present inside a Launch.
java.util.List<RebaseDiffEntry>	getDiffs(ContentFragmentLaunch cfLaunch, ContentFragmentLaunchOperationParameters params)	Gets the differences between the Content Fragment Launch and main content.
Resource	moveResource(Resource srcResource, java.lang.String destinationResourcePath, java.lang.String dstTitle)	Moves a resource to a new destination inside a Launch This method accounts for the source resource title, avoids name collisions and enables certain limitations that only apply to resources inside Content Fragment Launch.
void	rebaseLaunch(ContentFragmentLaunch launch, ContentFragmentLaunchOperationParameters params)	Rebase a launch based on the main content (brings changes from the main content into the Launch).
void	updateLaunchAfterCreatingResources(Resource launchPageResource, java.util.List<Resource> launchContentResources)	Performs actions like: - setting the last rebase field - updating references to a Content Fragment Launch and its resources after creating them.
void	updateSourceListInLaunch(Resource launchContentResource, java.util.List<LaunchSource> inputLaunchResourceList)	Updates the list of Content Fragments sources of a Content Fragment Launch.

Methods inherited from interface com.adobe.cq.launches.api.LaunchManager

cloneLaunch, createLaunch, createLaunch, deleteLaunch, getLaunch, getLaunches, getResourcesStatus, getResourcesStatus, getResourcesStatus, isInLaunch, promoteLaunch, updateLaunchSources

Method Detail

rebaseLaunch

void rebaseLaunch(@Nonnull
                  ContentFragmentLaunch launch,
                  @Nullable
                  ContentFragmentLaunchOperationParameters params)
           throws LaunchException

Rebase a launch based on the main content (brings changes from the main content into the Launch).

Parameters:

launch - Content Fragment Launch

params - Parameters of the rebase operation of the Content Fragment Launch

Throws:

LaunchException - If the rebase operation fails

getDiffs

java.util.List<RebaseDiffEntry> getDiffs(@Nonnull
                                         ContentFragmentLaunch cfLaunch,
                                         @Nullable
                                         ContentFragmentLaunchOperationParameters params)

Gets the differences between the Content Fragment Launch and main content.

Parameters:

cfLaunch - Content Fragment Launch

params - Parameters used to compute differences of a Content Fragment Launch

Returns:

list of rebase diff entries

moveResource

Resource moveResource(@Nonnull
                      Resource srcResource,
                      @Nonnull
                      java.lang.String destinationResourcePath,
                      @Nullable
                      java.lang.String dstTitle)

Moves a resource to a new destination inside a Launch This method accounts for the source resource title, avoids name collisions and enables certain limitations that only apply to resources inside Content Fragment Launch.

Parameters:

srcResource - Source resource

destinationResourcePath - Resource path of the destination

dstTitle - title of the moved resource

Returns:

moved resource

copyResource

Resource copyResource(@Nonnull
                      Resource srcResource,
                      @Nonnull
                      java.lang.String destinationResourcePath,
                      @Nullable
                      java.lang.String dstTitle)

Copies a resource to a new destination inside a Launch. This method accounts for the source resource title, avoids name collisions and enables certain limitations that only apply to resources inside Content Fragment Launch.

Parameters:

srcResource - Source resource

destinationResourcePath - Resource path of the destination

dstTitle - title of the copied resource

Returns:

copied resource

deleteResource

void deleteResource(@Nonnull
                    Resource resource)

Deletes a resource present inside a Launch. This method enables certain limitations that only apply to resources inside Content Fragment Launch.

Parameters:

resource - Resource to be deleted

updateSourceListInLaunch

void updateSourceListInLaunch(@Nonnull
                              Resource launchContentResource,
                              @Nonnull
                              java.util.List<LaunchSource> inputLaunchResourceList)
                       throws LaunchException

Updates the list of Content Fragments sources of a Content Fragment Launch.

Parameters:

launchContentResource - The content resource of a Launch (which holds the Content Fragment Launch sources)

inputLaunchResourceList - List of new Content Fragment Launch resources to replace the old one as sources

Throws:

LaunchException - If the rebase operation fails

updateLaunchAfterCreatingResources

void updateLaunchAfterCreatingResources(@Nonnull
                                        Resource launchPageResource,
                                        @Nonnull
                                        java.util.List<Resource> launchContentResources)

Performs actions like: - setting the last rebase field - updating references to a Content Fragment Launch and its resources after creating them.

Parameters:

launchPageResource - The root page resource of a Content Fragment Launch

launchContentResources - List of content resources previously added to the Content Framgnet Launch

createLaunchContentResources

java.util.List<Resource> createLaunchContentResources(@Nonnull
                                                      java.util.List<LaunchSource> inputLaunchResourceList,
                                                      @Nonnull
                                                      Resource launchPageResource,
                                                      @Nonnull
                                                      Page launchPage)

Creates content resources inside the Content Fragment Launch.

Parameters:

inputLaunchResourceList - The list of sources used for creating the Content Fragment Launch content resources

launchPageResource - The root page resource of a Content Fragment Launch

launchPage - The root page of a Content Fragment Launch

Returns:

The list of created content resources