Package com.adobe.cq.cif.common.associatedcontent

Class AssociatedContentService.XfParams

  • Enclosing interface:
    AssociatedContentService
    @ProviderType
public static final class AssociatedContentService.XfParams
extends java.lang.Object
    Defines the parameters used to query experience fragments as associated content.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Collection<java.lang.String> identifiers()
      Returns the product or category identifiers.
      java.lang.String location()
      Returns the experience fragment location.
      AssociatedContentService.XfParams location​(java.lang.String location)
      Sets the experience fragment location.
      static AssociatedContentService.XfParams of​(java.lang.String identifier)
      Creates an XfParams instance with a product or category identifier.
      static AssociatedContentService.XfParams of​(java.util.Collection<java.lang.String> identifiers)
      Creates an XfParams instance with a collection of product identifiers or category identifiers.
      java.lang.String path()
      Returns the search path.
      P path​(java.lang.String path)
      Sets the search path for associated content queries.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • location

        public java.lang.String location()
        Returns the experience fragment location.
        Returns:
        content experience location

      • location

        public AssociatedContentService.XfParams location​(java.lang.String location)
        Sets the experience fragment location.
        Parameters:
        location - experience fragment location
        Returns:
        the parameters instance

      • of

        public static AssociatedContentService.XfParams of​(java.lang.String identifier)
        Creates an XfParams instance with a product or category identifier.
        Parameters:
        identifier - product identifier or category identifier
        Returns:
        the new instance
        Throws:
        java.lang.IllegalArgumentException - for null or empty identifier

      • of

        public static AssociatedContentService.XfParams of​(java.util.Collection<java.lang.String> identifiers)
        Creates an XfParams instance with a collection of product identifiers or category identifiers.
        Parameters:
        identifiers - the product identifiers or category identifiers
        Returns:
        the new instance
        Throws:
        java.lang.IllegalArgumentException - for null or empty identifiers collection

      • identifiers

        public java.util.Collection<java.lang.String> identifiers()
        Returns the product or category identifiers.
        Returns:
        the product or category identifiers

      • path

        public java.lang.String path()
        Returns the search path.
        Returns:
        search path

      • path

        public P path​(java.lang.String path)
        Sets the search path for associated content queries.
        Parameters:
        path - associated content search path
        Returns:
        this params instance

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object