SubscriptionPlan Class Members

In This Topic

The following tables list the members exposed by SubscriptionPlan.

Public Constructors

	Name	Description
	SubscriptionPlan Constructor	Overloaded.

Top

Public Properties

	Name	Description
	Description	Gets or sets the Description
	ExtendedFields	Gets a manager that provides strongly typed access to extended fields. (Inherited from CommerceBuilder.DomainModel.Entity)
	Group	Gets or sets the Group
	GroupId	Gets or sets the Group for this entity.
	HasExtendedFields	Gets a value indicating whether the entity have extended fields or not (Inherited from CommerceBuilder.DomainModel.Entity)
	Id	Overridden. Gets or sets the Id for the entity.
	IsOptional	Gets or sets a value indicating whether subscription plan is optional or not
	IsRecurring	Gets a value indicating whether this subscription plan includes a recurring payment.
	Name	Gets or sets the Name
	NumberOfPayments	Gets or sets the NumberOfPayments
	OneTimeCharge	Gets or sets the OneTimeCharge
	OneTimeChargeEx	Gets the calculated one time charge for this subscription plan
	OneTimeChargeMode	Gets or sets the one time charge mode for this subscription plan
	OneTimeChargeModeId	Gets or sets the OneTimeChargeModeId
	OneTimeChargeTaxCode	Gets or sets the InitialChargeTaxCode
	OneTimeChargeTaxCodeId	Gets or sets the Recurring TaxCode for this entity.
	OptionalPaymentFrequencies	Gets or sets the OptionalPaymentFrequencies
	PaymentFrequency	Gets or sets the PaymentFrequency
	PaymentFrequencyType	Gets or sets the PaymentFrequencyType
	PaymentFrequencyTypeId	Gets or sets the PaymentFrequencyTypeId
	PaymentFrequencyUnit	Gets or sets a value indicating the unit of time that applies to the payment interval.
	PaymentFrequencyUnitId	Gets or sets the PaymentFrequencyUnitId
	Product	Gets or sets the Product
	ProductId	Gets or sets the ProductId associated with this subscription plan
	RecurringCharge	Gets or sets the RecurringCharge
	RecurringChargeMode	Gets or sets the recurring charge mode for this subscription plan
	RecurringChargeModeId	Gets or sets the RecurringChargeModeId
	RecurringChargeSpecified	Gets or sets a value indicating whether RecurringChargeSpecified
	RecurringTaxCode	Gets or sets the recurring TaxCode
	RecurringTaxCodeId	Gets or sets the Recurring TaxCode for this entity.
	RepeatDiscounts	Gets or sets a value indicating whether to repeat discounts in subsequent recurring orders/invoices or not
	Repository	Gets or sets an instance of the repository for this entity (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)
	Subscriptions	Gets or sets the Subscriptions

Top

Public Methods

	Name	Description
	CalculateExpiration	Calculates the expiration date for a subscription being activated.
	CalculateRecurringCharge	Calculates the recurring charge for this subscription.
	Copy	Create a shallow copy of this SubscriptionPlan instance.
	Equals	Determines if this object instance is equal to another. (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)
	Generate	Overloaded. Create a subscription for this plan for the given customer.
	GetHashCode	Serves as the default hash function. (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)
	GetSignatureProperties	Gets the signature properties for the class type. (Inherited from CommerceBuilder.DomainModel.BaseObject)
	HasSameObjectSignatureAs	You may override this method to provide your own comparison routine. (Inherited from CommerceBuilder.DomainModel.BaseObject)
	IsTransient	Transient objects are not associated with an item already in storage. For instance, a Customer is transient if its Id is 0. It's virtual to allow NHibernate-backed objects to be lazily loaded. (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)

Top

Protected Methods

	Name	Description
	GetTypeSpecificSignatureProperties	Enforces the template method pattern to have child objects determine which specific properties should and should not be included in the object signature comparison. Note that the the BaseObject already takes care of performance caching, so this method shouldn't worry about caching...just return the goods man! (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)
	GetTypeUnproxied	When NHibernate proxies objects, it masks the type of the actual entity object. This wrapper burrows into the proxied object to get its actual type. Although this assumes NHibernate is being used, it doesn't require any NHibernate related dependencies and has no bad side effects if NHibernate isn't being used. Related discussion is at http://groups.google.com/group/sharp-architecture/browse_thread/thread/ddd05f9baede023a ...thanks Jay Oliver! (Inherited from CommerceBuilder.DomainModel.BaseObject)

Name

Description

GetTypeSpecificSignatureProperties

Enforces the template method pattern to have child objects determine which specific properties should and should not be included in the object signature comparison. Note that the the BaseObject already takes care of performance caching, so this method shouldn't worry about caching...just return the goods man! (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)

GetTypeUnproxied

When NHibernate proxies objects, it masks the type of the actual entity object. This wrapper burrows into the proxied object to get its actual type.

Although this assumes NHibernate is being used, it doesn't require any NHibernate related dependencies and has no bad side effects if NHibernate isn't being used.

Related discussion is at http://groups.google.com/group/sharp-architecture/browse_thread/thread/ddd05f9baede023a ...thanks Jay Oliver!

(Inherited from CommerceBuilder.DomainModel.BaseObject)

Top

Extension Methods

	Name	Description
	Delete	Delete the entity from the database
	Save	Save the entity to the database
	ToQueryString	Overloaded. Use this method to bulid query string from NameValueCollection

Top

Reference

SubscriptionPlan Class
CommerceBuilder.Products Namespace

Send Feedback