au.org.consumerdatastandards.holder.model.telco

Class TelcoProductDetail

java.lang.Object

au.org.consumerdatastandards.holder.model.telco.TelcoProductDetail

public class TelcoProductDetail
extends Object

TelcoProductDetail

Constructor Summary

Constructors

Constructor and Description
TelcoProductDetail()

Method Summary

Modifier and Type	Method and Description
TelcoProductDetail	addBundlesItem(TelcoProductDetailBundles bundlesItem)
TelcoProductDetail	addDiscountsItem(TelcoProductDetailDiscounts discountsItem)
TelcoProductDetail	addIncentivesItem(TelcoProductDetailIncentives incentivesItem)
TelcoProductDetail	addMeteringChargesItem(TelcoProductDetailMeteringCharges meteringChargesItem)
TelcoProductDetail	addPlansItem(TelcoProductDetailPlan plansItem)
TelcoProductDetail	bundles(List<TelcoProductDetailBundles> bundles)
TelcoProductDetail	discounts(List<TelcoProductDetailDiscounts> discounts)
boolean	equals(Object o)
@Valid TelcoAdditionalInformation	getAdditionalInformation() Get additionalInformation
String	getApplicationUri() A link to an application web page where this plan can be applied for
@NotNull BillingTypeEnum	getBillingType() The type of product
@NotNull String	getBrand() The ID of the brand under which this product is offered
@NotNull String	getBrandName() The display name of the brand under which this product is offered
Boolean	getBundle() Required if part of a bundle.
@Valid List<TelcoProductDetailBundles>	getBundles() Bundles the product can be part of
@Valid TelcoContract	getContract() Get contract
String	getDescription() A description of the product
@Valid List<TelcoProductDetailDiscounts>	getDiscounts() Discounts associated to the product
String	getDisplayName() The display name of the product
String	getEffectiveFrom() The date and time from which this product is effective (ie.
String	getEffectiveTo() The date and time at which this product will be retired and will no longer be offered.
@Valid List<TelcoProductDetailIncentives>	getIncentives() Incentives associated to the product
String	getLastUpdated() The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)
@Valid List<TelcoProductDetailMeteringCharges>	getMeteringCharges() Charges for metering included in the plan
@Valid List<TelcoProductDetailPlan>	getPlans() Plans associated to the product
@NotNull @Valid List<TelcoProductPricing>	getPricing() List of pricing details for the product plan
@NotNull String	getProductId() The ID of the specific product
PurposeEnum	getPurpose() The purpose type of the product.
String	getThirdPartyAgentId() The ID of the Third Party through which this product may be originated
String	getThirdPartyAgentName() The display name of the Third Party through which this product may be originated
@NotNull TypeEnum	getType() The type of product
int	hashCode()
TelcoProductDetail	incentives(List<TelcoProductDetailIncentives> incentives)
TelcoProductDetail	meteringCharges(List<TelcoProductDetailMeteringCharges> meteringCharges)
TelcoProductDetail	plans(List<TelcoProductDetailPlan> plans)
void	setAdditionalInformation(TelcoAdditionalInformation additionalInformation)
void	setApplicationUri(String applicationUri)
void	setBillingType(BillingTypeEnum billingType)
void	setBrand(String brand)
void	setBrandName(String brandName)
void	setBundle(Boolean bundle)
void	setBundles(List<TelcoProductDetailBundles> bundles)
void	setContract(TelcoContract contract)
void	setDescription(String description)
void	setDiscounts(List<TelcoProductDetailDiscounts> discounts)
void	setDisplayName(String displayName)
void	setEffectiveFrom(String effectiveFrom)
void	setEffectiveTo(String effectiveTo)
void	setIncentives(List<TelcoProductDetailIncentives> incentives)
void	setLastUpdated(String lastUpdated)
void	setMeteringCharges(List<TelcoProductDetailMeteringCharges> meteringCharges)
void	setPlans(List<TelcoProductDetailPlan> plans)
void	setPricing(List<TelcoProductPricing> pricing)
void	setProductId(String productId)
void	setPurpose(PurposeEnum purpose)
void	setThirdPartyAgentId(String thirdPartyAgentId)
void	setThirdPartyAgentName(String thirdPartyAgentName)
void	setType(TypeEnum type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TelcoProductDetail

public TelcoProductDetail()

Method Detail

getProductId

@NotNull
public @NotNull String getProductId()

The ID of the specific product

Returns:

productId

setProductId

public void setProductId(String productId)

getEffectiveFrom

public String getEffectiveFrom()

The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate

Returns:

effectiveFrom

setEffectiveFrom

public void setEffectiveFrom(String effectiveFrom)

getEffectiveTo

public String getEffectiveTo()

The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of plans

Returns:

effectiveTo

setEffectiveTo

public void setEffectiveTo(String effectiveTo)

getLastUpdated

public String getLastUpdated()

The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)

Returns:

lastUpdated

setLastUpdated

public void setLastUpdated(String lastUpdated)

getDisplayName

public String getDisplayName()

The display name of the product

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

getDescription

public String getDescription()

A description of the product

Returns:

description

setDescription

public void setDescription(String description)

getType

@NotNull
public @NotNull TypeEnum getType()

The type of product

Returns:

type

setType

public void setType(TypeEnum type)

getPurpose

public PurposeEnum getPurpose()

The purpose type of the product. If absent, then the value PERSONAL is assumed

Returns:

purpose

setPurpose

public void setPurpose(PurposeEnum purpose)

getBillingType

@NotNull
public @NotNull BillingTypeEnum getBillingType()

The type of product

Returns:

billingType

setBillingType

public void setBillingType(BillingTypeEnum billingType)

getContract

@Valid
public @Valid TelcoContract getContract()

Get contract

Returns:

contract

setContract

public void setContract(TelcoContract contract)

getBundle

public Boolean getBundle()

Required if part of a bundle. If not present FALSE is assumed

Returns:

bundle

setBundle

public void setBundle(Boolean bundle)

getBrand

@NotNull
public @NotNull String getBrand()

The ID of the brand under which this product is offered

Returns:

brand

setBrand

public void setBrand(String brand)

getBrandName

@NotNull
public @NotNull String getBrandName()

The display name of the brand under which this product is offered

Returns:

brandName

setBrandName

public void setBrandName(String brandName)

getPricing

@NotNull
 @Valid
public @NotNull @Valid List<TelcoProductPricing> getPricing()

List of pricing details for the product plan

Returns:

pricing

setPricing

public void setPricing(List<TelcoProductPricing> pricing)

getThirdPartyAgentId

public String getThirdPartyAgentId()

The ID of the Third Party through which this product may be originated

Returns:

thirdPartyAgentId

setThirdPartyAgentId

public void setThirdPartyAgentId(String thirdPartyAgentId)

getThirdPartyAgentName

public String getThirdPartyAgentName()

The display name of the Third Party through which this product may be originated

Returns:

thirdPartyAgentName

setThirdPartyAgentName

public void setThirdPartyAgentName(String thirdPartyAgentName)

getApplicationUri

public String getApplicationUri()

A link to an application web page where this plan can be applied for

Returns:

applicationUri

setApplicationUri

public void setApplicationUri(String applicationUri)

getAdditionalInformation

@Valid
public @Valid TelcoAdditionalInformation getAdditionalInformation()

Get additionalInformation

Returns:

additionalInformation

setAdditionalInformation

public void setAdditionalInformation(TelcoAdditionalInformation additionalInformation)

meteringCharges

public TelcoProductDetail meteringCharges(List<TelcoProductDetailMeteringCharges> meteringCharges)

addMeteringChargesItem

public TelcoProductDetail addMeteringChargesItem(TelcoProductDetailMeteringCharges meteringChargesItem)

getMeteringCharges

@Valid
public @Valid List<TelcoProductDetailMeteringCharges> getMeteringCharges()

Charges for metering included in the plan

Returns:

meteringCharges

setMeteringCharges

public void setMeteringCharges(List<TelcoProductDetailMeteringCharges> meteringCharges)

bundles

public TelcoProductDetail bundles(List<TelcoProductDetailBundles> bundles)

addBundlesItem

public TelcoProductDetail addBundlesItem(TelcoProductDetailBundles bundlesItem)

getBundles

@Valid
public @Valid List<TelcoProductDetailBundles> getBundles()

Bundles the product can be part of

Returns:

bundles

setBundles

public void setBundles(List<TelcoProductDetailBundles> bundles)

plans

public TelcoProductDetail plans(List<TelcoProductDetailPlan> plans)

addPlansItem

public TelcoProductDetail addPlansItem(TelcoProductDetailPlan plansItem)

getPlans

@Valid
public @Valid List<TelcoProductDetailPlan> getPlans()

Plans associated to the product

Returns:

plans

setPlans

public void setPlans(List<TelcoProductDetailPlan> plans)

discounts

public TelcoProductDetail discounts(List<TelcoProductDetailDiscounts> discounts)

addDiscountsItem

public TelcoProductDetail addDiscountsItem(TelcoProductDetailDiscounts discountsItem)

getDiscounts

@Valid
public @Valid List<TelcoProductDetailDiscounts> getDiscounts()

Discounts associated to the product

Returns:

discounts

setDiscounts

public void setDiscounts(List<TelcoProductDetailDiscounts> discounts)

incentives

public TelcoProductDetail incentives(List<TelcoProductDetailIncentives> incentives)

addIncentivesItem

public TelcoProductDetail addIncentivesItem(TelcoProductDetailIncentives incentivesItem)

getIncentives

@Valid
public @Valid List<TelcoProductDetailIncentives> getIncentives()

Incentives associated to the product

Returns:

incentives

setIncentives

public void setIncentives(List<TelcoProductDetailIncentives> incentives)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object