au.org.consumerdatastandards.holder.model.telco

Class TelcoProduct

java.lang.Object

au.org.consumerdatastandards.holder.model.telco.TelcoProduct

public class TelcoProduct
extends Object

TelcoProduct

Constructor Summary

Constructors

Constructor and Description
TelcoProduct()

Method Summary

Modifier and Type	Method and Description
TelcoProduct	additionalInformation(TelcoAdditionalInformation additionalInformation)
TelcoProduct	addPricingItem(TelcoProductPricing pricingItem)
TelcoProduct	applicationUri(String applicationUri)
TelcoProduct	billingType(BillingTypeEnum billingType)
TelcoProduct	brand(String brand)
TelcoProduct	brandName(String brandName)
TelcoProduct	bundle(Boolean bundle)
TelcoProduct	contract(TelcoContract contract)
TelcoProduct	description(String description)
TelcoProduct	displayName(String displayName)
TelcoProduct	effectiveFrom(String effectiveFrom)
TelcoProduct	effectiveTo(String effectiveTo)
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 TelcoContract	getContract() Get contract
String	getDescription() A description of 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.
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)
@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()
TelcoProduct	lastUpdated(String lastUpdated)
TelcoProduct	pricing(List<TelcoProductPricing> pricing)
TelcoProduct	productId(String productId)
TelcoProduct	purpose(PurposeEnum purpose)
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	setContract(TelcoContract contract)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setEffectiveFrom(String effectiveFrom)
void	setEffectiveTo(String effectiveTo)
void	setLastUpdated(String lastUpdated)
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)
TelcoProduct	thirdPartyAgentId(String thirdPartyAgentId)
TelcoProduct	thirdPartyAgentName(String thirdPartyAgentName)
String	toString()
TelcoProduct	type(TypeEnum type)

Methods inherited from class java.lang.Object

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

Constructor Detail

TelcoProduct

public TelcoProduct()

Method Detail

productId

public TelcoProduct productId(String productId)

getProductId

@NotNull
public @NotNull String getProductId()

The ID of the specific product

Returns:

productId

setProductId

public void setProductId(String productId)

effectiveFrom

public TelcoProduct effectiveFrom(String effectiveFrom)

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)

effectiveTo

public TelcoProduct effectiveTo(String effectiveTo)

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)

lastUpdated

public TelcoProduct lastUpdated(String lastUpdated)

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)

displayName

public TelcoProduct displayName(String displayName)

getDisplayName

public String getDisplayName()

The display name of the product

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

description

public TelcoProduct description(String description)

getDescription

public String getDescription()

A description of the product

Returns:

description

setDescription

public void setDescription(String description)

type

public TelcoProduct type(TypeEnum type)

getType

@NotNull
public @NotNull TypeEnum getType()

The type of product

Returns:

type

setType

public void setType(TypeEnum type)

purpose

public TelcoProduct purpose(PurposeEnum purpose)

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)

billingType

public TelcoProduct billingType(BillingTypeEnum billingType)

getBillingType

@NotNull
public @NotNull BillingTypeEnum getBillingType()

The type of product

Returns:

billingType

setBillingType

public void setBillingType(BillingTypeEnum billingType)

contract

public TelcoProduct contract(TelcoContract contract)

getContract

@Valid
public @Valid TelcoContract getContract()

Get contract

Returns:

contract

setContract

public void setContract(TelcoContract contract)

bundle

public TelcoProduct bundle(Boolean bundle)

getBundle

public Boolean getBundle()

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

Returns:

bundle

setBundle

public void setBundle(Boolean bundle)

brand

public TelcoProduct brand(String brand)

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)

brandName

public TelcoProduct brandName(String brandName)

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)

pricing

public TelcoProduct pricing(List<TelcoProductPricing> pricing)

addPricingItem

public TelcoProduct addPricingItem(TelcoProductPricing pricingItem)

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)

thirdPartyAgentId

public TelcoProduct thirdPartyAgentId(String thirdPartyAgentId)

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)

thirdPartyAgentName

public TelcoProduct thirdPartyAgentName(String thirdPartyAgentName)

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)

applicationUri

public TelcoProduct applicationUri(String applicationUri)

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)

additionalInformation

public TelcoProduct additionalInformation(TelcoAdditionalInformation additionalInformation)

getAdditionalInformation

@Valid
public @Valid TelcoAdditionalInformation getAdditionalInformation()

Get additionalInformation

Returns:

additionalInformation

setAdditionalInformation

public void setAdditionalInformation(TelcoAdditionalInformation additionalInformation)

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