com.adobe.cq.screens.assignment

Interface AssignmentService

All Superinterfaces:

AssignmentResolver

@ProviderType
public interface AssignmentService
extends AssignmentResolver

Manages the assignments in the repository.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<Resource>	CHANNEL_ASSIGNMENT_PRIORITY_COMPARATOR Sorts a list of channel assignments based on priority property.

Method Summary

Modifier and Type	Method and Description
void	delete(Resource assignment) Deletes the provided assignment and the associated copied configs.
java.util.Iterator<Resource>	findDisplaysForEntity(Resource resource) Find the displays that reference the specified resource.
java.util.Iterator<Resource>	findRootAssignmentsForEntity(Resource resource) Find the root assignments for the specified resource (i.e.
Resource	getParentEntity(Resource assignment) Gets the parent entity (display or schedule) that contains this assignment.
java.lang.String	getRoleForAssignment(Resource channel, Resource assignment) Returns the role of the channel assignment of the provided channel or schedule assignment.
boolean	isAssignment(Resource resource) Checks whether the specified resource is an assignment.
Resource	resolve(ResourceResolver resolver, Resource parent, Resource assignment) Deprecated.

Methods inherited from interface com.adobe.cq.screens.assignment.AssignmentResolver

findAssignmentsForEntity, findDisplaysForAssignment, getSupportedResourceType, resolveEntity, resolveEntity

Field Detail

CHANNEL_ASSIGNMENT_PRIORITY_COMPARATOR

static final java.util.Comparator<Resource> CHANNEL_ASSIGNMENT_PRIORITY_COMPARATOR

Sorts a list of channel assignments based on priority property.

Method Detail

isAssignment

boolean isAssignment(@Nonnull
                     Resource resource)

Checks whether the specified resource is an assignment.

Parameters:

resource - The resource to check

Returns:

true if the resource is an assignment, false otherwise

findRootAssignmentsForEntity

@Nonnull
java.util.Iterator<Resource> findRootAssignmentsForEntity(@Nonnull
                                                                   Resource resource)

Find the root assignments for the specified resource (i.e. the assignments under a display that directly or indirectly point to that resource)

Parameters:

resource - The referenced resource

Returns:

The root assignments that point to this resource

findDisplaysForEntity

@Nonnull
java.util.Iterator<Resource> findDisplaysForEntity(@Nonnull
                                                            Resource resource)

Find the displays that reference the specified resource.

Parameters:

resource - The referenced resource

Returns:

The displays that point to this resource

getParentEntity

@Nullable
Resource getParentEntity(@Nonnull
                                   Resource assignment)

Gets the parent entity (display or schedule) that contains this assignment.

Parameters:

assignment - The assignment to get the parent of

Returns:

The parent entity for the specified assignment

resolve

@Deprecated
Resource resolve(@Nonnull
                             ResourceResolver resolver,
                             @Nonnull
                             Resource parent,
                             Resource assignment)

Deprecated.

Resolves the channel or schedule resource in the context of the given parent resource.

Parameters:

resolver - The resource resolver

parent - The parent in which to look for the assignment

assignment - The assignment resource

Returns:

The resolved schedule resource, or null

getRoleForAssignment

@Nullable
java.lang.String getRoleForAssignment(@Nonnull
                                                Resource channel,
                                                @Nonnull
                                                Resource assignment)

Returns the role of the channel assignment of the provided channel or schedule assignment.

Parameters:

channel - The channel

assignment - The assignment

Returns:

The role, or null

delete

void delete(@Nonnull
            Resource assignment)
     throws PersistenceException

Deletes the provided assignment and the associated copied configs.

Parameters:

assignment - The channel assignment in question

Throws:

PersistenceException - if there is an error deleting the assignment