com.adobe.cq.screens.display

Interface DisplayService

public interface DisplayService

Manages the displays in the repository.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<Resource>	getAssignments(ResourceResolver resolver, Resource display) The assignments for the specified Display.
java.util.Iterator<Resource>	getAssignmentsForSchedule(ResourceResolver resolver, Resource display, Resource schedule) Deprecated.
Resource	getDisplay(Resource assignment) Gets the display for the specified assignment
Resource	resolveChannel(ResourceResolver resolver, Resource display, Resource assignment) Deprecated.
Resource	resolveChannel(ResourceResolver resolver, Resource display, java.lang.String role) Resolves the channel resource for the specified channel assignment.
Resource	resolveSchedule(ResourceResolver resolver, Resource display, Resource assignment) Deprecated.
void	unassign(ResourceResolver resolver, Resource display, Resource channel) Remove the assignment for the specified channel on this display

Method Detail

getDisplay

Resource getDisplay(Resource assignment)

Gets the display for the specified assignment

Parameters:

assignment - The assignment

Returns:

The display that contains the assignment

getAssignments

java.util.Iterator<Resource> getAssignments(ResourceResolver resolver,
                                            Resource display)

The assignments for the specified Display.

Parameters:

resolver - The resource resolver

display - The display in which to look for the assignment

Returns:

All assignments

getAssignmentsForSchedule

@Deprecated
java.util.Iterator<Resource> getAssignmentsForSchedule(ResourceResolver resolver,
                                                                   Resource display,
                                                                   Resource schedule)

Deprecated.

The assignments for a schedule in the context of a display assigned to the schedule.

Parameters:

resolver - The resource resolver

display - The display in which context the dynamic channels are referenced

schedule - The schedule in which to look for the assignment

Returns:

All assignments for a schedule

resolveChannel

Resource resolveChannel(ResourceResolver resolver,
                        Resource display,
                        java.lang.String role)

Resolves the channel resource for the specified channel assignment.

Parameters:

resolver - The resource resolver

display - The display in which to look for the assignment

role - The role of the assignment

Returns:

The resolved channel resource, or null

resolveChannel

@Deprecated
Resource resolveChannel(ResourceResolver resolver,
                                    Resource display,
                                    Resource assignment)

Deprecated.

Resolves the channel resource for the specified channel assignment.

Parameters:

resolver - The resource resolver

display - The display in which to look for the assignment

assignment - The assignment resource

Returns:

The resolved channel resource, or null

resolveSchedule

@Deprecated
Resource resolveSchedule(ResourceResolver resolver,
                                     Resource display,
                                     Resource assignment)

Deprecated.

Resolves the schedule resource for the specified schedule assignment.

Parameters:

resolver - The resource resolver

display - The display in which to look for the assignment

assignment - The assignment resource

Returns:

The resolved channel resource, or null

unassign

void unassign(ResourceResolver resolver,
              Resource display,
              Resource channel)
       throws PersistenceException,
              RepositoryException

Remove the assignment for the specified channel on this display

Parameters:

resolver - The resource resolver

display - The display to remove the assignment from

channel - The channel for which we want to remove the assignment

Throws:

PersistenceException - if the deletion fails

RepositoryException