Class ChannelTreeResource


  • @Path("/lum-internal/admin/portal-studio/channeltree")
    public class ChannelTreeResource
    extends java.lang.Object
    Since:
    7.1.0
    Version:
    $Revision: 20895 $ $Date: 2018-01-18 17:58:18 -0200 (Thu, 18 Jan 2018) $
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getChannelChildren​(java.lang.String filterType, java.lang.String channelId)
      Get all children from the referenced channel
      java.lang.String getChannelChildren​(java.lang.String filterType, java.lang.String channelId, java.lang.String channelIdToIgnoreOrServiceId)
      Get all children from the referenced channel including his service instance but filtered by the referenced service id
      java.lang.String getInitialTree​(java.lang.String filterType, java.lang.String channelIdToIgnoreOrServiceId, HttpServletResponse response, boolean localizeNames)
      Returns the JSON string with a list of the first subchannel level from the Portal root channel with only the desired service instances.
      java.lang.String getInitialTree​(java.lang.String filterType, HttpServletResponse response, boolean localizeNames)
      Returns the JSON string with a list of the first subchannel level from the Portal root channel.
      java.lang.String getPartialInitialTree​(java.lang.String rootChannelId, java.lang.String filterType, HttpServletResponse response, boolean localizeNames)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ChannelTreeResource

        public ChannelTreeResource()
    • Method Detail

      • getInitialTree

        @GET
        @Path("/getinitialtree/{filtertype}/{channelIdToIgnoreOrServiceId}")
        @Produces("application/json")
        public java.lang.String getInitialTree​(@PathParam("filtertype")
                                               java.lang.String filterType,
                                               @PathParam("channelIdToIgnoreOrServiceId")
                                               java.lang.String channelIdToIgnoreOrServiceId,
                                               @Context
                                               HttpServletResponse response,
                                               @QueryParam("localizeNames") @DefaultValue("true")
                                               boolean localizeNames)
        Returns the JSON string with a list of the first subchannel level from the Portal root channel with only the desired service instances.
        Parameters:
        filterType - filter type that can be page, page-template, channel, channel-template and service-instance.
        serviceinstanceid -
        Returns:
        the JSON string with a list of the first subchannel level.
        Since:
        7.1.0
      • getInitialTree

        @GET
        @Path("/getinitialtree/{filtertype}")
        @Produces("application/json")
        public java.lang.String getInitialTree​(@PathParam("filtertype")
                                               java.lang.String filterType,
                                               @Context
                                               HttpServletResponse response,
                                               @QueryParam("localizeNames") @DefaultValue("true")
                                               boolean localizeNames)
        Returns the JSON string with a list of the first subchannel level from the Portal root channel.
        Parameters:
        filterType - filter type that can be page, page-template, channel, channel-template and service-instance.
        Returns:
        the JSON string with a list of the first subchannel level.
        Since:
        7.1.0
      • getChannelChildren

        @GET
        @Path("/getchannelchildren/{filtertype}/{channelId}")
        @Produces("application/json")
        public java.lang.String getChannelChildren​(@PathParam("filtertype")
                                                   java.lang.String filterType,
                                                   @PathParam("channelId")
                                                   java.lang.String channelId)
        Get all children from the referenced channel
        Parameters:
        filterType - filter type that can be page, page-template, channel, channel-template and service-instance.
        channelId - referenced channel id
        Returns:
        the JSON string with a list of the first subchannel level.
        Since:
        7.1.0
      • getChannelChildren

        @GET
        @Path("/getchannelchildren/{filtertype}/{channelId}/{channelIdToIgnoreOrServiceId}")
        @Produces("application/json")
        public java.lang.String getChannelChildren​(@PathParam("filtertype")
                                                   java.lang.String filterType,
                                                   @PathParam("channelId")
                                                   java.lang.String channelId,
                                                   @PathParam("channelIdToIgnoreOrServiceId")
                                                   java.lang.String channelIdToIgnoreOrServiceId)
        Get all children from the referenced channel including his service instance but filtered by the referenced service id
        Parameters:
        filterType - filter type that can be page, page-template, channel, channel-template and service-instance.
        channelId - referenced channel id
        channelIdToIgnoreOrServiceId - referenced service id
        Returns:
        the JSON string with a list of the first subchannel level containing there service instances.
        Since:
        7.1.0