com.adobe.cq.screens.assignment

Interface AssignmentResolver

All Known Subinterfaces:

AssignmentService

@ConsumerType
public interface AssignmentResolver

An interface that allows defining a new class that manages the assignments between Display/Schedules and Schedules/Channels. The assignment resolver is tied to a specific assignment resource type and contains all the logic to travers the repository up or down the relationship tree, and thus allows easy extension. Resolvers will be automatically loaded by the AssignmentService that is the entry point for all assignment resolving methods.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<Resource>	findAssignmentsForEntity(Resource resource) Find the assignments that reference the specified resource.
java.util.Iterator<Resource>	findDisplaysForAssignment(Resource assignment) Find the displays that point to the specified assignment.
java.lang.String	getSupportedResourceType() Returns the supported resource type for this assignment resolver
Resource	resolveEntity(Resource assignment) Resolves the referenced resource.
Resource	resolveEntity(Resource assignment, Resource context) Resolves the referenced resource.

Method Detail

getSupportedResourceType

java.lang.String getSupportedResourceType()

Returns the supported resource type for this assignment resolver

Returns:

the supported resource type

resolveEntity

@Nullable
Resource resolveEntity(@Nonnull
                                 Resource assignment)

Resolves the referenced resource.

Parameters:

assignment - The assignment resource

Returns:

The resolved resource, or null

resolveEntity

@Nullable
Resource resolveEntity(@Nonnull
                                 Resource assignment,
                                 Resource context)

Resolves the referenced resource.

Parameters:

assignment - The assignment resource

context - Resource that defines the context in which to resolve the referenced resource

Returns:

The resolved resource, or null

findDisplaysForAssignment

@Nonnull
java.util.Iterator<Resource> findDisplaysForAssignment(@Nonnull
                                                                Resource assignment)

Find the displays that point to the specified assignment.

Parameters:

assignment - The assignment resource

Returns:

The displays that point to this assignment

findAssignmentsForEntity

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

Find the assignments that reference the specified resource.

Parameters:

resource - The referenced resource

Returns:

The assignment that reference that entity