How to use

PlanSpecifier

in

org.killbill.billing.catalog.api

public PlanChangeResult planChange(final PlanPhaseSpecifier from, final PlanSpecifier to, final StaticCatalog catalog) throws CatalogApiException {
  final DefaultPriceList toPriceList = to.getPriceListName() != null ?
                     (DefaultPriceList) catalog.findCurrentPricelist(to.getPriceListName()) :
                     findPriceList(from, catalog);
  // If we use old scheme {product, billingPeriod, pricelist}, ensure pricelist is correct
  // (Pricelist may be null because if it is unspecified this is the principal use-case)
  final PlanSpecifier toWithPriceList = to.getPlanName() == null ?
                     new PlanSpecifier(to.getProductName(), to.getBillingPeriod(), toPriceList.getName()) :
                     to;
  final BillingActionPolicy policy = getPlanChangePolicy(from, toWithPriceList, catalog);
  if (policy == BillingActionPolicy.ILLEGAL) {
    throw new IllegalPlanChange(from, toWithPriceList);
  }
  final PlanAlignmentChange alignment = getPlanChangeAlignment(from, toWithPriceList, catalog);
  return new PlanChangeResult(toPriceList, policy, alignment);
}

@Override
public Plan createOrFindCurrentPlan(final PlanSpecifier spec, final PlanPhasePriceOverridesWithCallContext unused) throws CatalogApiException {
  final Plan result;
  if (spec.getPlanName() != null) {
    result = findCurrentPlan(spec.getPlanName());
  } else {
    if (spec.getProductName() == null) {
      throw new CatalogApiException(ErrorCode.CAT_NULL_PRODUCT_NAME);
    }
    if (spec.getBillingPeriod() == null) {
      throw new CatalogApiException(ErrorCode.CAT_NULL_BILLING_PERIOD);
    }
    final String inputOrDefaultPricelist = (spec.getPriceListName() == null) ? PriceListSet.DEFAULT_PRICELIST_NAME : spec.getPriceListName();
    final Product product = findCurrentProduct(spec.getProductName());
    result = priceLists.getPlanFrom(product, spec.getBillingPeriod(), inputOrDefaultPricelist);
  }
  if (result == null) {
    throw new CatalogApiException(ErrorCode.CAT_PLAN_NOT_FOUND,
                   spec.getPlanName() != null ? spec.getPlanName() : "undefined",
                   spec.getProductName() != null ? spec.getProductName() : "undefined",
                   spec.getBillingPeriod() != null ? spec.getBillingPeriod() : "undefined",
                   spec.getPriceListName() != null ? spec.getPriceListName() : "undefined");
  }
  return result;
}

private DefaultPriceList findPriceList(final PlanSpecifier specifier, final StaticCatalog catalog) throws CatalogApiException {
  DefaultPriceList result = DefaultCasePriceList.getResult(priceListCase, specifier, catalog);
  if (result == null) {
    final String priceListName = specifier.getPlanName() != null ? catalog.findCurrentPlan(specifier.getPlanName()).getPriceListName() : specifier.getPriceListName();
    result = (DefaultPriceList) catalog.findCurrentPricelist(priceListName);
  }
  return result;
}

public PlanRequestWrapper(final String planName) {
  this(new PlanSpecifier(planName));
}

public IllegalPlanChange(final PlanPhaseSpecifier from,
             final PlanSpecifier to) {
  super(ErrorCode.CAT_ILLEGAL_CHANGE_REQUEST, from.getProductName(), from.getBillingPeriod(), from.getPriceListName(), to.getProductName(), to.getBillingPeriod(), to.getPriceListName());
}

public T getResult(final PlanPhaseSpecifier specifier, final StaticCatalog c) throws CatalogApiException {
  if ((phaseType == null || specifier.getPhaseType() == phaseType)
    && satisfiesCase(new PlanSpecifier(specifier), c)) {
    return getResult();
  }
  return null;
}

public IllegalPlanChange(final Throwable cause, final PlanPhaseSpecifier from,
             final PlanSpecifier to) {
  super(cause, ErrorCode.CAT_ILLEGAL_CHANGE_REQUEST, from.getProductName(), from.getBillingPeriod(), from.getPriceListName(), to.getProductName(), to.getBillingPeriod(), to.getPriceListName());
}

private DefaultPriceList findPriceList(final PlanSpecifier specifier, final StaticCatalog catalog) throws CatalogApiException {
  DefaultPriceList result = DefaultCasePriceList.getResult(priceListCase, specifier, catalog);
  if (result == null) {
    final String priceListName = specifier.getPlanName() != null ? catalog.findCurrentPlan(specifier.getPlanName()).getPriceListName() : specifier.getPriceListName();
    result = (DefaultPriceList) catalog.findCurrentPricelist(priceListName);
  }
  return result;
}

  protected void assertion(final Result result, final DefaultCaseResult cr, final String productName, final ProductCategory productCategory, final BillingPeriod bp, final String priceListName, final StandaloneCatalog cat) throws CatalogApiException {
    Assert.assertEquals(result, cr.getResult(new PlanSpecifier(productName, bp, priceListName), cat));
  }
}

public IllegalPlanChange(final Throwable cause, final PlanPhaseSpecifier from,
             final PlanSpecifier to) {
  super(cause, ErrorCode.CAT_ILLEGAL_CHANGE_REQUEST, from.getProductName(), from.getBillingPeriod(), from.getPriceListName(), to.getProductName(), to.getBillingPeriod(), to.getPriceListName());
}

spec.getPlanName() != null ? spec.getPlanName() : "undefined",
spec.getProductName() != null ? spec.getProductName() : "undefined",
spec.getBillingPeriod() != null ? spec.getBillingPeriod() : "undefined",
spec.getPriceListName() != null ? spec.getPriceListName() : "undefined");

protected void assertionNull(final DefaultCaseResult cr, final String productName, final ProductCategory productCategory, final BillingPeriod bp, final String priceListName, final StandaloneCatalog cat) throws CatalogApiException {
  Assert.assertNull(cr.getResult(new PlanSpecifier(productName, bp, priceListName), cat));
}

public IllegalPlanChange(final PlanPhaseSpecifier from,
             final PlanSpecifier to) {
  super(ErrorCode.CAT_ILLEGAL_CHANGE_REQUEST, from.getProductName(), from.getBillingPeriod(), from.getPriceListName(), to.getProductName(), to.getBillingPeriod(), to.getPriceListName());
}

protected boolean satisfiesCase(final PlanSpecifier planPhase, final StaticCatalog c) throws CatalogApiException {
  final Product product;
  final BillingPeriod billingPeriod;
  final ProductCategory productCategory;
  final PriceList priceList;
  if (planPhase.getPlanName() != null) {
    final Plan plan = c.findCurrentPlan(planPhase.getPlanName());
    product = plan.getProduct();
    billingPeriod = plan.getRecurringBillingPeriod();
    productCategory = plan.getProduct().getCategory();
    priceList = c.findCurrentPricelist(plan.getPriceListName());
  } else {
    product = c.findCurrentProduct(planPhase.getProductName());
    billingPeriod = planPhase.getBillingPeriod();
    productCategory = product.getCategory();
    priceList = getPriceList() != null ? c.findCurrentPricelist(planPhase.getPriceListName()) : null;
  }
  return (getProduct() == null || getProduct().equals(product)) &&
      (getProductCategory() == null || getProductCategory().equals(productCategory)) &&
      (getBillingPeriod() == null || getBillingPeriod().equals(billingPeriod)) &&
      (getPriceList() == null || getPriceList().equals(priceList));
}

private List<TimedPhase> getTimedPhaseOnCreate(final DateTime subscriptionStartDate,
                        final DateTime bundleStartDate,
                        final Plan plan,
                        @Nullable final PhaseType initialPhase,
                        final Catalog catalog,
                        final DateTime catalogEffectiveDate,
                        final InternalTenantContext context)
    throws CatalogApiException, SubscriptionBaseApiException {
  final PlanSpecifier planSpecifier = new PlanSpecifier(plan.getName());
  final DateTime planStartDate;
  final PlanAlignmentCreate alignment = catalog.planCreateAlignment(planSpecifier, catalogEffectiveDate, subscriptionStartDate);
  switch (alignment) {
    case START_OF_SUBSCRIPTION:
      planStartDate = subscriptionStartDate;
      break;
    case START_OF_BUNDLE:
      planStartDate = bundleStartDate;
      break;
    default:
      throw new SubscriptionBaseError(String.format("Unknown PlanAlignmentCreate %s", alignment));
  }
  return getPhaseAlignments(plan, initialPhase, planStartDate);
}

final ProductCategory inToProductCategory;
final PriceList inToPriceList;
if (to.getPlanName() != null) {
  final Plan plan = catalog.findCurrentPlan(to.getPlanName());
  inToProduct = plan.getProduct();
  inToBillingPeriod = plan.getRecurringBillingPeriod();
  inToPriceList = catalog.findCurrentPricelist(plan.getPriceListName());
} else {
  inToProduct = catalog.findCurrentProduct(to.getProductName());
  inToBillingPeriod = to.getBillingPeriod();
  inToProductCategory = inToProduct.getCategory();
  inToPriceList = to.getPriceListName() != null ? catalog.findCurrentPricelist(to.getPriceListName()) : null;

protected void assertionNull(final DefaultCaseChangeResult cr,
               final String fromProductName, final String toProductName,
               final ProductCategory fromProductCategory, final ProductCategory toProductCategory,
               final BillingPeriod fromBp, final BillingPeriod toBp,
               final String fromPriceListName, final String toPriceListName,
               final PhaseType phaseType, final StandaloneCatalog cat) {
  try {
    Assert.assertNull(cr.getResult(new PlanPhaseSpecifier(fromProductName, fromBp, fromPriceListName, phaseType),
                    new PlanSpecifier(toProductName, toBp, toPriceListName), cat));
  } catch (CatalogApiException e) {
    Assert.fail("", e);
  }
}

@Override
public Plan createOrFindCurrentPlan(final PlanSpecifier spec, final PlanPhasePriceOverridesWithCallContext unused) throws CatalogApiException {
  final Plan result;
  if (spec.getPlanName() != null) {
    result = findCurrentPlan(spec.getPlanName());
  } else {
    if (spec.getProductName() == null) {
      throw new CatalogApiException(ErrorCode.CAT_NULL_PRODUCT_NAME);
    }
    if (spec.getBillingPeriod() == null) {
      throw new CatalogApiException(ErrorCode.CAT_NULL_BILLING_PERIOD);
    }
    final String inputOrDefaultPricelist = (spec.getPriceListName() == null) ? PriceListSet.DEFAULT_PRICELIST_NAME : spec.getPriceListName();
    final Product product = findCurrentProduct(spec.getProductName());
    result = priceLists.getPlanFrom(product, spec.getBillingPeriod(), inputOrDefaultPricelist);
  }
  if (result == null) {
    throw new CatalogApiException(ErrorCode.CAT_PLAN_NOT_FOUND,
                   spec.getPlanName() != null ? spec.getPlanName() : "undefined",
                   spec.getProductName() != null ? spec.getProductName() : "undefined",
                   spec.getBillingPeriod() != null ? spec.getBillingPeriod() : "undefined",
                   spec.getPriceListName() != null ? spec.getPriceListName() : "undefined");
  }
  return result;
}

  protected void assertion(final Result result, final DefaultCaseChangeResult cr,
               final String fromProductName, final String toProductName,
               final BillingPeriod fromBp, final BillingPeriod toBp,
               final String fromPriceListName, final String toPriceListName,
               final PhaseType phaseType, final StandaloneCatalog cat) {
    try {
      Assert.assertEquals(result, cr.getResult(new PlanPhaseSpecifier(fromProductName, fromBp, fromPriceListName, phaseType),
                           new PlanSpecifier(toProductName, toBp, toPriceListName), cat));
    } catch (CatalogApiException e) {
      Assert.fail("", e);
    }
  }
}

public PlanChangeResult planChange(final PlanPhaseSpecifier from, final PlanSpecifier to, final StaticCatalog catalog) throws CatalogApiException {
  final DefaultPriceList toPriceList = to.getPriceListName() != null ?
                     (DefaultPriceList) catalog.findCurrentPricelist(to.getPriceListName()) :
                     findPriceList(from, catalog);
  // If we use old scheme {product, billingPeriod, pricelist}, ensure pricelist is correct
  // (Pricelist may be null because if it is unspecified this is the principal use-case)
  final PlanSpecifier toWithPriceList = to.getPlanName() == null ?
                     new PlanSpecifier(to.getProductName(), to.getBillingPeriod(), toPriceList.getName()) :
                     to;
  final BillingActionPolicy policy = getPlanChangePolicy(from, toWithPriceList, catalog);
  if (policy == BillingActionPolicy.ILLEGAL) {
    throw new IllegalPlanChange(from, toWithPriceList);
  }
  final PlanAlignmentChange alignment = getPlanChangeAlignment(from, toWithPriceList, catalog);
  return new PlanChangeResult(toPriceList, policy, alignment);
}