QPlanReader Class

Querying Custom Fields from Stored Products

As of Quotes 9.7, you can use the Store Existing Products Job to query custom fields from Zuora. See Store Custom Fields for Existing Products for the details.

The QPlanReader class uses the same field sets to indicate which fields should be loaded onto the CPQ X data model objects as the storeExistingProductsJob job. See the following table for the object and field set mapping. 

QPlanReader.Settings Class Properties

The QPlanReader.Settings class includes the following global properties.

QPlanReader.Settings Global Methods

The QPlanReader.Settings class includes the following global methods.

Load QPlan List Based on the Specified quoteId

The following sample code shows how to get the QPlan List under a Quote based on the quoteId. 

public void test(){
    String amendQuoteId = 'quoteId_xxx1'; // Amendment quote with 1 added plan, 1 unmodified original plan, 1 original plan that has been updated and 1 original plan that had been flagged for removal
    List<QPlan> plans = zqu.QPlanReader.load(amendQuoteId);
    Map<String, Integer> countOfAmendmentTypes = new Map<String, Integer>();
    for (QPlan plan: plans) {
        String amendmentType = (String) plan.getAmendment().get('zqu__Type__c');
        if (!countOfAmendmentTypes.containsKey(amendmentType)) {
            countOfPlanTypes.put(amendmentType, 0);
        }
        Int newCount = countOfAmendmentTypes.get(amendmentType) + 1;
        countOfAmendmentTypes.put(amendmentType, newCount)
    }
    System.assertEquals(4, qPlans.size());
    System.assertEquals(1, countOfAmendmentTypes.get('NewProduct'));
    System.assertEquals(1, countOfAmendmentTypes.get('UpdateProduct'));
    System.assertEquals(1, countOfAmendmentTypes.get('RemoveProduct'));
    System.assertEquals(1, countOfAmendmentTypes.get('Original'));
}

Apply an offset to Load QPlans

The following sample code shows how to set the offset through QPlanReader.Setting class and apply it to load the QPlans starting from the offset under a given Quote. 

public void test(){
    String amendQuoteId = 'quoteId_xxx1'; // Amendment quote with 1 added plan, 1 unmodified original plan, 1 original plan that has been updated and 1 original plan that had been flagged for removal
    List<QPlan> plans = QPlanReader.load(amendQuoteId);
    System.assertEquals(4, plans.size());
     
    // Apply advanced settings
    QPlanReader.Settings readerSettings = new QPlanReader.Settings();
    readerSettings.setQuoteId(amendQuoteId);
    readerSettings.setPlanOffset(1);
    QPlanReader.Result readerResult = QPlanReader.load(readerSettings);
    List<QPlan> offsetPlans = readerResult.getPlans();
 
    // Verify that offset has been applied
    System.assertEquals(3, offsetPlans.size());
}

Apply a limit to Load QPlans

The following sample code shows how to set the limit through QPlanReader.Setting class and apply it to load the specified number of QPlans under a given Quote. 

public void test(){
    String amendQuoteId = 'quoteId_xxx1'; // Amendment quote with 1 added plan, 1 unmodified original plan, 1 original plan that has been updated and 1 original plan that had been flagged for removal
    List<QPlan> plans = QPlanReader.load(amendQuoteId);
    System.assertEquals(4, plans.size());
     
    // Apply advanced settings
    QPlanReader.Settings readerSettings = new QPlanReader.Settings();
    readerSettings.setQuoteId(amendQuoteId);
    readerSettings.setPlanLimit(1);
    QPlanReader.Result readerResult = QPlanReader.load(readerSettings);
    List<QPlan> limitedPlans = readerResult.getPlans();
 
    // Verify that limit has been applied
    System.assertEquals(1, limitedPlans.size());
}

Load QPlans with a Set of QuoteRatePlan Ids

The following sample code first makes 1000 Quote Plans with QPlanBuilder and then retrieves 500 of them.

• Make QPlans with QPlanBuilder:

Id productRatePlanId = <Product Rate Plan ID>;
Id quoteId = <New Quote ID>;
List<Id> productRatePlanIds = new List<Id>();
for(Integer i = 0; i < 500; i++)
   productRatePlanIds.add(productRatePlanId);
List<QPlan> plansToAdd = zqu.QPlanBuilder.makeFromCatalog(quoteId, productRatePlanIds);
zqu.QPlanWriter.save(plansToAdd);

• Retreive QPlans with QPlanReader:

Map<Id, zqu__QuoteRatePlan__c> quoteRatePlansById = new Map<Id,zqu__QuoteRatePlan__c> (
  [SELECT Id FROM zqu__QuoteRatePlan__c WHERE zqu__Quote__c = :quoteId LIMIT 500]
);
Set<Id> quoteRatePlanIdsForLoad = quoteRatePlansById.keySet();

zqu.QPlanReader.Settings readerSettings = new zqu.QPlanReader.Settings();
readerSettings.setQuoteRatePlanIds(quoteRatePlanIdsForLoad);
List<zqu.QPlan> loadedQPlans = zqu.QPlanReader.load(readerSettings).getPlans();

System.assertEquals(500, loadedQPlans.size());