Class AskKodiak.CompanyQuery.CompanyQueryBuilder
- java.lang.Object
-
- com.trustedchoice.askkodiak.v2.client.AskKodiak.CompanyQuery.CompanyQueryBuilder
-
- Enclosing class:
- AskKodiak.CompanyQuery
public static class AskKodiak.CompanyQuery.CompanyQueryBuilder extends java.lang.Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AskKodiak.CompanyQuery.CompanyQueryBuilder
annualPayroll(java.lang.String annualPayroll)
Filters response to include only products with expressly stated eligibility for a given annual payroll amount.AskKodiak.CompanyQuery.CompanyQueryBuilder
annualRevenue(java.lang.String annualRevenue)
Filters response to include only products with expressly stated eligibility for a given annual revenue amount.AskKodiak.CompanyQuery.CompanyQueryBuilder
anticipatedPremium(java.lang.String anticipatedPremium)
Filters response to include only products in the specified premium range or amount.AskKodiak.CompanyQuery
build()
AskKodiak.CompanyQuery.CompanyQueryBuilder
entityTypes(java.lang.String entityTypes)
Filters response to include only products expressly eligible for a given entity type or types.AskKodiak.CompanyQuery.CompanyQueryBuilder
fullTimeEmployees(java.lang.String fullTimeEmployees)
Filters response to include only products with expressly stated eligibility for a given number of full time employees.AskKodiak.CompanyQuery.CompanyQueryBuilder
geos(java.lang.String geos)
Filter response to include only products available in requested geography(s) and apply any conditional rules which pertain to them.AskKodiak.CompanyQuery.CompanyQueryBuilder
includeEligibility(java.lang.Boolean includeEligibility)
Request that eligible hashes be included on products in the response.AskKodiak.CompanyQuery.CompanyQueryBuilder
naicsCodes(java.lang.String naicsCodes)
Filter response to include only products with eligibility for a specific hash or hashes and apply any conditional rules which pertain to them.AskKodiak.CompanyQuery.CompanyQueryBuilder
naicsGroups(java.lang.String naicsGroups)
Filter response to include only products with eligibility for a specific 2-6 digit NAICS group or groups and apply any conditional rules which pertain to them.AskKodiak.CompanyQuery.CompanyQueryBuilder
page(java.lang.Integer page)
Get specific page of results.AskKodiak.CompanyQuery.CompanyQueryBuilder
partTimeEmployees(java.lang.String partTimeEmployees)
Filters response to include only products with expressly stated eligibility for a given number of part time employees.AskKodiak.CompanyQuery.CompanyQueryBuilder
productCodes(java.lang.String productCodes)
Filter response to include only products matching the requested coverage or coverages.AskKodiak.CompanyQuery.CompanyQueryBuilder
productsPerPage(java.lang.Integer productsPerPage)
Limit the response to a maximum number of products.AskKodiak.CompanyQuery.CompanyQueryBuilder
summaryOnly(java.lang.Boolean summaryOnly)
Request that only summary information be returned for products in the response including (if available on resultant products) name, ownerId, id, coverageType, and logo.AskKodiak.CompanyQuery.CompanyQueryBuilder
tags(java.lang.String tags)
Filters response to include only products matching the requested tag or tags.java.lang.String
toString()
AskKodiak.CompanyQuery.CompanyQueryBuilder
yearsInBusiness(java.lang.String yearsInBusiness)
Filters response to include only products with expressly stated eligibility for entities who have been in business for a given amount time.AskKodiak.CompanyQuery.CompanyQueryBuilder
yearsInIndustry(java.lang.String yearsInIndustry)
Filters response to include only products with expressly stated eligibility for entities who have a given amount of operating experience in the industry.
-
-
-
Method Detail
-
naicsGroups
public AskKodiak.CompanyQuery.CompanyQueryBuilder naicsGroups(java.lang.String naicsGroups)
Filter response to include only products with eligibility for a specific 2-6 digit NAICS group or groups and apply any conditional rules which pertain to them. Use + as separator to include more than one naics group. Usage naicsGroups=722514 or naicsGroups=44-45+722515.
-
naicsCodes
public AskKodiak.CompanyQuery.CompanyQueryBuilder naicsCodes(java.lang.String naicsCodes)
Filter response to include only products with eligibility for a specific hash or hashes and apply any conditional rules which pertain to them. Use + as separator to include more than one hash. Usage naicsCodes=9d709a5f8cefe02c3ba71bdd3a4c3e28 or naicsCodes=9d709a5f8cefe02c3ba71bdd3a4c3e28+4797cab0bb586ec0a98da773878ef97d.
-
includeEligibility
public AskKodiak.CompanyQuery.CompanyQueryBuilder includeEligibility(java.lang.Boolean includeEligibility)
Request that eligible hashes be included on products in the response. Potentially increases response payload significantly, especially in those cases where the results include a large number of products. If this parameter is missing, excluded, or set to false eligible classes will not be present on products in the response.
-
summaryOnly
public AskKodiak.CompanyQuery.CompanyQueryBuilder summaryOnly(java.lang.Boolean summaryOnly)
Request that only summary information be returned for products in the response including (if available on resultant products) name, ownerId, id, coverageType, and logo. If this parameter is missing, excluded, or set to false all available properties will be present on products in the response. Please Note: in the event that summaryOnly is set to true, the includeEligibility parameter will be forced to false.
-
geos
public AskKodiak.CompanyQuery.CompanyQueryBuilder geos(java.lang.String geos)
Filter response to include only products available in requested geography(s) and apply any conditional rules which pertain to them. Use + as separator to include more than 1 ISO 3166-2 code. Usage geos=US-HI or geos=US-MN+CA-ON. A filter of geos=US-MN+US-HI means products available in Minnesota OR Hawaii.
-
productCodes
public AskKodiak.CompanyQuery.CompanyQueryBuilder productCodes(java.lang.String productCodes)
Filter response to include only products matching the requested coverage or coverages. Use + as separator to include more than 1 product code. Usage productCodes=BOP or productCodes=BOP+WORK. A filter of productCodes=BOP+WORK means products that have BOP OR Work Comp coverage.
-
entityTypes
public AskKodiak.CompanyQuery.CompanyQueryBuilder entityTypes(java.lang.String entityTypes)
Filters response to include only products expressly eligible for a given entity type or types. Use + as separator to include more than 1 entity type code. Usage entityTypes=AS or entityTypes=AS+CCORP. A filter of entityTypes=AS+CCORP means include products eligible to either 'Association' or 'C-Corporation' entity types. A full list of valid entity types can be attained from ReferenceData/BusinessEntityTypes
-
tags
public AskKodiak.CompanyQuery.CompanyQueryBuilder tags(java.lang.String tags)
Filters response to include only products matching the requested tag or tags. Use + as separator to include more than 1 tag. Usage tags=external-website or tags=external-website+internal-portal. A filter of tags=external-website+internal-portal+marketABC123 means all products which have either the tag external-website, internal-portal, or marketABC123.
-
annualPayroll
public AskKodiak.CompanyQuery.CompanyQueryBuilder annualPayroll(java.lang.String annualPayroll)
Filters response to include only products with expressly stated eligibility for a given annual payroll amount. Usage annualPayroll=10000000
-
annualRevenue
public AskKodiak.CompanyQuery.CompanyQueryBuilder annualRevenue(java.lang.String annualRevenue)
Filters response to include only products with expressly stated eligibility for a given annual revenue amount. Usage annualRevenue=50000000
-
anticipatedPremium
public AskKodiak.CompanyQuery.CompanyQueryBuilder anticipatedPremium(java.lang.String anticipatedPremium)
Filters response to include only products in the specified premium range or amount. If specifying a range, min and max values should be separated with a dash as shown in the example. Usage anticipatedPremium=1000 or anticipatedPremium=1000-10000.
-
fullTimeEmployees
public AskKodiak.CompanyQuery.CompanyQueryBuilder fullTimeEmployees(java.lang.String fullTimeEmployees)
Filters response to include only products with expressly stated eligibility for a given number of full time employees. Usage fullTimeEmployees=100
-
partTimeEmployees
public AskKodiak.CompanyQuery.CompanyQueryBuilder partTimeEmployees(java.lang.String partTimeEmployees)
Filters response to include only products with expressly stated eligibility for a given number of part time employees. Usage partTimeEmployees=24
-
yearsInBusiness
public AskKodiak.CompanyQuery.CompanyQueryBuilder yearsInBusiness(java.lang.String yearsInBusiness)
Filters response to include only products with expressly stated eligibility for entities who have been in business for a given amount time. Usage yearsInBusiness=5
-
yearsInIndustry
public AskKodiak.CompanyQuery.CompanyQueryBuilder yearsInIndustry(java.lang.String yearsInIndustry)
Filters response to include only products with expressly stated eligibility for entities who have a given amount of operating experience in the industry. Usage yearsInIndustry=10
-
productsPerPage
public AskKodiak.CompanyQuery.CompanyQueryBuilder productsPerPage(java.lang.Integer productsPerPage)
Limit the response to a maximum number of products.
-
page
public AskKodiak.CompanyQuery.CompanyQueryBuilder page(java.lang.Integer page)
Get specific page of results. Page numbers are zero-based, so to retrieve the 6th page, you should set page=5. If productsPerPage is not specified all products will be included in the results.
-
build
public AskKodiak.CompanyQuery build()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-