Package com.adobe.aio.cloudmanager

Interface ContentSet

public interface ContentSet

A Content Set definition

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ContentSet.PathDefinition	A path definition for a content set, containing a root path definition, and excluded sub paths.

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete this content set definition.
String	getDescription()	Description of the content set.
String	getId()	The id of this Content Set.
String	getName()	User-friendly name of this Content Set
Collection<ContentSet.PathDefinition>	getPathDefinitions()	The path definitions within this content set
String	getProgramId()	The id of the associated program context
@NotNull ContentFlow	startFlow(@NotNull String srcEnvironmentId, @NotNull String destEnvironmentId, boolean includeAcl)	Start a content flow between the specified environments, using the specified content set.
void	update(String name, String description, Collection<ContentSet.PathDefinition> definitions)	Update this content set with the changes.

Method Detail

getId

String getId()

The id of this Content Set.

Returns:

the id

getProgramId

String getProgramId()

The id of the associated program context

Returns:

the program id

getName

String getName()

User-friendly name of this Content Set

Returns:

the name

getDescription

String getDescription()

Description of the content set.

Returns:

the description

getPathDefinitions

Collection<ContentSet.PathDefinition> getPathDefinitions()

The path definitions within this content set

Returns:

the path definitions

update

void update(String name,
            String description,
            Collection<ContentSet.PathDefinition> definitions)
     throws CloudManagerApiException

Update this content set with the changes. Any parameters not specified will be left in their current state.

Parameters:

name - the new name, or null to leave unchanged

description - the new description, or null to leave unchanged

definitions - the new definitions, or null to leave unchanged

Throws:

CloudManagerApiException - when any error occurs

delete

void delete()
     throws CloudManagerApiException

Delete this content set definition.

Throws:

CloudManagerApiException - when any error occurs

startFlow

@NotNull
@NotNull ContentFlow startFlow(@NotNull
                               @NotNull String srcEnvironmentId,
                               @NotNull
                               @NotNull String destEnvironmentId,
                               boolean includeAcl)
                        throws CloudManagerApiException

Start a content flow between the specified environments, using the specified content set.

Parameters:

srcEnvironmentId - the id of the source environment

destEnvironmentId - the id of the destination environment

includeAcl - whether to include the content's ACL definitions

Returns:

the content flow

Throws:

CloudManagerApiException - when any error occurs