Package com.trustedchoice.askkodiak.v2.model.product

Class Products

  • public class Products
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Products()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.lang.String getCode()
      The NAICS code (2-6 digit) for which the request applied.
      java.lang.Integer getCount()
      The total count of products returned by this search.
      java.lang.String getDescription()
      Description text associated with the NAICS code or hash for which the request was made.
      java.util.Map<java.lang.String,​java.lang.Object> getFilters()
      An object summarizing the filters (if any) applied to the initial request.
      java.util.Optional<java.lang.String> getHash()
      A restatement of the class code hash requested.
      java.lang.Boolean getIncludeEligibility()
      Is the eligibility property attached to products in the results?
      java.lang.Integer getPage()
      The page of results which the response represents.
      java.lang.Integer getPages()
      The total number of result pages available.
      java.util.Optional<Product> getProduct()
      An individual product eligible for the requested NAICS code.
      java.util.List<Product> getProducts()
      A list of 0-n product objects eligible for this code.
      java.lang.Integer getProductsPerPage()
      The number of products in each page of product results.
      java.util.Optional<java.lang.String> getSeq()
      The NAICS sequence number of the requested group.
      java.lang.Boolean getSummaryOnly()
      Are products in the products in the response limited to summary information only?
      java.util.Optional<java.lang.String> getType()
      The type of NAICS group represented by the requested group (e.g.
      int hashCode()  
      void setCode​(java.lang.String code)
      The NAICS code (2-6 digit) for which the request applied.
      void setCount​(java.lang.Integer count)
      The total count of products returned by this search.
      void setDescription​(java.lang.String description)
      Description text associated with the NAICS code or hash for which the request was made.
      void setFilters​(java.util.Map<java.lang.String,​java.lang.Object> filters)
      An object summarizing the filters (if any) applied to the initial request.
      void setHash​(java.lang.String hash)
      A restatement of the class code hash requested.
      void setIncludeEligibility​(java.lang.Boolean includeEligibility)
      Is the eligibility property attached to products in the results?
      void setPage​(java.lang.Integer page)
      The page of results which the response represents.
      void setPages​(java.lang.Integer pages)
      The total number of result pages available.
      void setProduct​(Product product)
      An individual product eligible for the requested NAICS code.
      void setProducts​(java.util.List<Product> products)
      A list of 0-n product objects eligible for this code.
      void setProductsPerPage​(java.lang.Integer productsPerPage)
      The number of products in each page of product results.
      void setSeq​(java.lang.String seq)
      The NAICS sequence number of the requested group.
      void setSummaryOnly​(java.lang.Boolean summaryOnly)
      Are products in the products in the response limited to summary information only?
      void setType​(java.lang.String type)
      The type of NAICS group represented by the requested group (e.g.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Products

        public Products()

    • Method Detail

      • getHash

        public java.util.Optional<java.lang.String> getHash()
        A restatement of the class code hash requested. Present if the request was made using an MD5 hash of 6 digit national industry code and description. In the event a valid 2012 NAICS edition hash was submitted, it has been mapped to it's 2017 equivalent, and the 2017 hash value will be found in this property.

      • getType

        public java.util.Optional<java.lang.String> getType()
        The type of NAICS group represented by the requested group (e.g. sector, subsector, industry-group, international-industry, or national-industry). This will be present only on requests made using a 2-6 digit code.

      • getSeq

        public java.util.Optional<java.lang.String> getSeq()
        The NAICS sequence number of the requested group. This will be present only on requests made using a 2-6 digit code.

      • getProduct

        public java.util.Optional<Product> getProduct()
        An individual product eligible for the requested NAICS code.

        In the event that summaryOnly was set to true on the request, only the name, id, and ownerId properties will be present on products in the results. If summaryOnly is omitted from the request or set to false, complete product objects - rendered in accordance with the governing conditions as expressed by the request filters - will be returned. For documentation about the singleton product instances in this array see the documentation for Product/GetProduct. For requests made at the NAICS Group level (i.e. 2-6 digit codes) each product in the results has been extended with a property _percentOfCodesEligibleInRequestedGroup which contains a numeric value representing the percentage of codes in this group for which the product is eligible. 1 means, 100%, 0.016241 means a little less than 2% and so on. When present, results will be sorted by this property in descending order.

      • getCode

        public java.lang.String getCode()
        The NAICS code (2-6 digit) for which the request applied.

      • getDescription

        public java.lang.String getDescription()
        Description text associated with the NAICS code or hash for which the request was made.

      • getCount

        public java.lang.Integer getCount()
        The total count of products returned by this search.

      • getProductsPerPage

        public java.lang.Integer getProductsPerPage()
        The number of products in each page of product results.

      • getPage

        public java.lang.Integer getPage()
        The page of results which the response represents.

      • getPages

        public java.lang.Integer getPages()
        The total number of result pages available.

      • getSummaryOnly

        public java.lang.Boolean getSummaryOnly()
        Are products in the products in the response limited to summary information only?

      • getIncludeEligibility

        public java.lang.Boolean getIncludeEligibility()
        Is the eligibility property attached to products in the results?

      • getFilters

        public java.util.Map<java.lang.String,​java.lang.Object> getFilters()
        An object summarizing the filters (if any) applied to the initial request. TODO: Document this better and/or strongly type this

      • getProducts

        public java.util.List<Product> getProducts()
        A list of 0-n product objects eligible for this code.

      • setHash

        public void setHash​(java.lang.String hash)
        A restatement of the class code hash requested. Present if the request was made using an MD5 hash of 6 digit national industry code and description. In the event a valid 2012 NAICS edition hash was submitted, it has been mapped to it's 2017 equivalent, and the 2017 hash value will be found in this property.

      • setCode

        public void setCode​(java.lang.String code)
        The NAICS code (2-6 digit) for which the request applied.

      • setDescription

        public void setDescription​(java.lang.String description)
        Description text associated with the NAICS code or hash for which the request was made.

      • setType

        public void setType​(java.lang.String type)
        The type of NAICS group represented by the requested group (e.g. sector, subsector, industry-group, international-industry, or national-industry). This will be present only on requests made using a 2-6 digit code.

      • setSeq

        public void setSeq​(java.lang.String seq)
        The NAICS sequence number of the requested group. This will be present only on requests made using a 2-6 digit code.

      • setCount

        public void setCount​(java.lang.Integer count)
        The total count of products returned by this search.

      • setProductsPerPage

        public void setProductsPerPage​(java.lang.Integer productsPerPage)
        The number of products in each page of product results.

      • setPage

        public void setPage​(java.lang.Integer page)
        The page of results which the response represents.

      • setPages

        public void setPages​(java.lang.Integer pages)
        The total number of result pages available.

      • setSummaryOnly

        public void setSummaryOnly​(java.lang.Boolean summaryOnly)
        Are products in the products in the response limited to summary information only?

      • setIncludeEligibility

        public void setIncludeEligibility​(java.lang.Boolean includeEligibility)
        Is the eligibility property attached to products in the results?

      • setFilters

        public void setFilters​(java.util.Map<java.lang.String,​java.lang.Object> filters)
        An object summarizing the filters (if any) applied to the initial request. TODO: Document this better and/or strongly type this

      • setProducts

        public void setProducts​(java.util.List<Product> products)
        A list of 0-n product objects eligible for this code.

      • setProduct

        public void setProduct​(Product product)
        An individual product eligible for the requested NAICS code.

        In the event that summaryOnly was set to true on the request, only the name, id, and ownerId properties will be present on products in the results. If summaryOnly is omitted from the request or set to false, complete product objects - rendered in accordance with the governing conditions as expressed by the request filters - will be returned. For documentation about the singleton product instances in this array see the documentation for Product/GetProduct. For requests made at the NAICS Group level (i.e. 2-6 digit codes) each product in the results has been extended with a property _percentOfCodesEligibleInRequestedGroup which contains a numeric value representing the percentage of codes in this group for which the product is eligible. 1 means, 100%, 0.016241 means a little less than 2% and so on. When present, results will be sorted by this property in descending order.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

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