Class AskKodiak.EligibleQuery
- java.lang.Object
-
- com.trustedchoice.askkodiak.v2.client.AskKodiak.EligibleQuery
-
- Enclosing interface:
- AskKodiak
public static class AskKodiak.EligibleQuery extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AskKodiak.EligibleQuery.EligibleQueryBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AskKodiak.EligibleQuery.EligibleQueryBuilder
builder()
java.lang.String
getAnnualPayroll()
Filters response to include only products with expressly stated eligibility for a given annual payroll amount.java.lang.String
getAnnualRevenue()
Filters response to include only products with expressly stated eligibility for a given annual revenue amount.java.lang.String
getAnticipatedPremium()
Filters response to include only products in the specified premium range or amount.java.lang.String
getEntityTypes()
Filters response to include only products expressly eligible for a given entity type or types.java.lang.String
getFullTimeEmployees()
Filters response to include only products with expressly stated eligibility for a given number of full time employees.java.lang.String
getGeos()
Filter response to include only products available in requested geography(s) and apply any conditional rules which pertain to them.java.lang.Boolean
getIncludeEligibility()
Request that eligible hashes be included on products in the response.java.lang.String
getOwners()
Filters response to include only products belonging to the requested owner(s).java.lang.Integer
getPage()
Get specific page of results.java.lang.String
getPartTimeEmployees()
Filters response to include only products with expressly stated eligibility for a given number of part time employees.java.lang.String
getProductCodes()
Filter response to include only products matching the requested coverage or coverages.java.lang.Integer
getProductsPerPage()
Limit the response to a maximum number of products.java.lang.Boolean
getSummaryOnly()
Request that only summary information be returned for products in the response including (if available on resultant products) name, ownerId, id, coverageType, and logo.java.lang.String
getTags()
Filters response to include only products matching the requested tag or tags.java.lang.String
getYearsInBusiness()
Filters response to include only products with expressly stated eligibility for entities who have been in business for a given amount time.java.lang.String
getYearsInIndustry()
Filters response to include only products with expressly stated eligibility for entities who have a given amount of operating experience in the industry.void
setAnnualPayroll(java.lang.String annualPayroll)
Filters response to include only products with expressly stated eligibility for a given annual payroll amount.void
setAnnualRevenue(java.lang.String annualRevenue)
Filters response to include only products with expressly stated eligibility for a given annual revenue amount.void
setAnticipatedPremium(java.lang.String anticipatedPremium)
Filters response to include only products in the specified premium range or amount.void
setEntityTypes(java.lang.String entityTypes)
Filters response to include only products expressly eligible for a given entity type or types.void
setFullTimeEmployees(java.lang.String fullTimeEmployees)
Filters response to include only products with expressly stated eligibility for a given number of full time employees.void
setGeos(java.lang.String geos)
Filter response to include only products available in requested geography(s) and apply any conditional rules which pertain to them.void
setIncludeEligibility(java.lang.Boolean includeEligibility)
Request that eligible hashes be included on products in the response.void
setOwners(java.lang.String owners)
Filters response to include only products belonging to the requested owner(s).void
setPage(java.lang.Integer page)
Get specific page of results.void
setPartTimeEmployees(java.lang.String partTimeEmployees)
Filters response to include only products with expressly stated eligibility for a given number of part time employees.void
setProductCodes(java.lang.String productCodes)
Filter response to include only products matching the requested coverage or coverages.void
setProductsPerPage(java.lang.Integer productsPerPage)
Limit the response to a maximum number of products.void
setSummaryOnly(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.void
setTags(java.lang.String tags)
Filters response to include only products matching the requested tag or tags.void
setYearsInBusiness(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.void
setYearsInIndustry(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
-
builder
public static AskKodiak.EligibleQuery.EligibleQueryBuilder builder()
-
getOwners
public java.lang.String getOwners()
Filters response to include only products belonging to the requested owner(s). Use + as separator to include more than company id. Usage owners=ABC123 or owners=ABC123+DEF456. A filter of owners=ABC123+DEF456 means products owned by group with id ABC123 OR products owned by group with id DEF456.
-
getIncludeEligibility
public java.lang.Boolean getIncludeEligibility()
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.
-
getSummaryOnly
public java.lang.Boolean getSummaryOnly()
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.
-
getGeos
public java.lang.String getGeos()
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.
-
getProductCodes
public java.lang.String getProductCodes()
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.
-
getEntityTypes
public java.lang.String getEntityTypes()
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
-
getTags
public java.lang.String getTags()
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.
-
getAnnualPayroll
public java.lang.String getAnnualPayroll()
Filters response to include only products with expressly stated eligibility for a given annual payroll amount. Usage annualPayroll=10000000
-
getAnnualRevenue
public java.lang.String getAnnualRevenue()
Filters response to include only products with expressly stated eligibility for a given annual revenue amount. Usage annualRevenue=50000000
-
getAnticipatedPremium
public java.lang.String getAnticipatedPremium()
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.
-
getFullTimeEmployees
public java.lang.String getFullTimeEmployees()
Filters response to include only products with expressly stated eligibility for a given number of full time employees. Usage fullTimeEmployees=100
-
getPartTimeEmployees
public java.lang.String getPartTimeEmployees()
Filters response to include only products with expressly stated eligibility for a given number of part time employees. Usage partTimeEmployees=24
-
getYearsInBusiness
public java.lang.String getYearsInBusiness()
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
-
getYearsInIndustry
public java.lang.String getYearsInIndustry()
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
-
getProductsPerPage
public java.lang.Integer getProductsPerPage()
Limit the response to a maximum number of products.
-
getPage
public java.lang.Integer getPage()
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.
-
setOwners
public void setOwners(java.lang.String owners)
Filters response to include only products belonging to the requested owner(s). Use + as separator to include more than company id. Usage owners=ABC123 or owners=ABC123+DEF456. A filter of owners=ABC123+DEF456 means products owned by group with id ABC123 OR products owned by group with id DEF456.
-
setIncludeEligibility
public void setIncludeEligibility(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.
-
setSummaryOnly
public void setSummaryOnly(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.
-
setGeos
public void setGeos(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.
-
setProductCodes
public void setProductCodes(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.
-
setEntityTypes
public void setEntityTypes(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
-
setTags
public void setTags(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.
-
setAnnualPayroll
public void setAnnualPayroll(java.lang.String annualPayroll)
Filters response to include only products with expressly stated eligibility for a given annual payroll amount. Usage annualPayroll=10000000
-
setAnnualRevenue
public void setAnnualRevenue(java.lang.String annualRevenue)
Filters response to include only products with expressly stated eligibility for a given annual revenue amount. Usage annualRevenue=50000000
-
setAnticipatedPremium
public void setAnticipatedPremium(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.
-
setFullTimeEmployees
public void setFullTimeEmployees(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
-
setPartTimeEmployees
public void setPartTimeEmployees(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
-
setYearsInBusiness
public void setYearsInBusiness(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
-
setYearsInIndustry
public void setYearsInIndustry(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
-
setProductsPerPage
public void setProductsPerPage(java.lang.Integer productsPerPage)
Limit the response to a maximum number of products.
-
setPage
public void setPage(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.
-
-