Developer Resources for AbleCommerce eCommerce platform
CommerceBuilder.Orders Namespace / Subscription Class
Properties Methods


In This Topic
    Subscription Class Members
    In This Topic

    The following tables list the members exposed by Subscription.

    Public Constructors
     NameDescription
    Public ConstructorSubscription ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyBasePrice Gets or sets the BasePrice  
    Public PropertyBaseTaxCode Gets or sets the BaseTaxCode  
    Public PropertyBillToAddress1 Gets or sets the BillToAddress1  
    Public PropertyBillToAddress2 Gets or sets the BillToAddress2  
    Public PropertyBillToCity Gets or sets the BillToCity  
    Public PropertyBillToCompany Gets or sets the BillToCompany  
    Public PropertyBillToCountry Gets the bill to country  
    Public PropertyBillToCountryCode Gets or sets the BillToCountryCode  
    Public PropertyBillToEmail Gets or sets the BillToEmail  
    Public PropertyBillToFax Gets or sets the BillToFax  
    Public PropertyBillToFirstName Gets or sets the BillToFirstName  
    Public PropertyBillToLastName Gets or sets the BillToLastName  
    Public PropertyBillToPhone Gets or sets the BillToPhone  
    Public PropertyBillToPostalCode Gets or sets the BillToPostalCode  
    Public PropertyBillToProvince Gets or sets the BillToProvince  
    Public PropertyBillToResidence Gets or sets a value indicating whether the BillToResidence  
    Public PropertyExpirationAlertDate Gets or sets the ExpirationAlertDate  
    Public PropertyExpirationDate Gets or sets the ExpirationDate  
    Public PropertyExpiredAlertDate Gets or sets the ExpiredAlertDate  
    Public PropertyExtendedFields Gets a manager that provides strongly typed access to extended fields. (Inherited from CommerceBuilder.DomainModel.Entity)
    Public PropertyGroupId Gets or sets the GroupId  
    Public PropertyHasExtendedFields Gets a value indicating whether the entity have extended fields or not (Inherited from CommerceBuilder.DomainModel.Entity)
    Public PropertyIdOverridden.  Gets or sets the Id for the entity.  
    Public PropertyIsActive Gets or sets a value indicating whether IsActive  
    Public PropertyIsLegacy Gets or sets a value indicating whether its legacy subscription or not  
    Public PropertyLastOrderDueDate Gets or sets the LastOrderDueDate  
    Public PropertyName Gets or sets the Name  
    Public PropertyNextOrderDateForDisplay Gets the next order date for display purpose  
    Public PropertyNextOrderDueDate Gets or sets the NextOrderDate  
    Public PropertyNumberOfPayments Gets or sets the NumberOfPayments  
    Public PropertyOrderDate Gets the order date for this subscription.  
    Public PropertyOrderItem Gets or sets the OrderItem  
    Public PropertyOrderItemId Gets or sets the OrderItem for this entity.  
    Public PropertyPaymentFrequency Gets or sets the PaymentFrequency  
    Public PropertyPaymentFrequencyUnit Gets or sets the PaymentFrequencyUnit  
    Public PropertyPaymentFrequencyUnitId Gets or sets the PaymentFrequencyUnitId  
    Public PropertyPaymentMethod Gets or sets the PaymentMethod  
    Public PropertyPaymentProcessingType Gets or sets the PaymentProcessingType  
    Public PropertyPaymentProcessingTypeId Gets or sets the PaymentProcessingTypeId  
    Public PropertyPaymentProfile Gets or sets the PaymentProfile  
    Public PropertyPayments Gets or sets the Payments  
    Public PropertyProcessingStatus Gets or sets the processing status  
    Public PropertyProcessingStatusId Gets or sets the ProcessingStatusId  
    Public PropertyProcessingStatusMessage Gets or sets the ProcessingStatusMessage  
    Public PropertyProduct Gets the product associated with the subscription  
    Public PropertyProductId Gets the ProductId  
    Public PropertyQuantity Gets or sets the Quantity  
    Public PropertyRecurringCharge Gets or sets the RecurringCharge  
    Public PropertyRecurringChargeEx Gets the effective recurring charge, calculated based on the recurring charge mode and value  
    Public PropertyRecurringChargeMode Gets or sets the recurring charge mode for this subscription plan  
    Public PropertyRecurringChargeModeId Gets or sets the RecurringChargeModeId  
    Public PropertyRecurringChargeSpecified Gets or sets a value indicating whether RecurringChargeSpecified  
    Public PropertyRecurringTaxCode Gets or sets the RecurringTaxCode  
    Public PropertyRecurringTaxCodeEx Gets the effective tax code for the recurring charge  
    Public PropertyRepeatDiscounts Gets or sets a value indicating whether to repeat discounts in subsequent recurring orders/invoices or not  
    Public PropertyRepository Gets or sets an instance of the repository for this entity (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)
    Public PropertyShipToAddress1 Gets or sets the ShipToAddress1  
    Public PropertyShipToAddress2 Gets or sets the ShipToAddress2  
    Public PropertyShipToCity Gets or sets the ShipToCity  
    Public PropertyShipToCompany Gets or sets the ShipToCompany  
    Public PropertyShipToCountry Gets the ship to country  
    Public PropertyShipToCountryCode Gets or sets the ShipToCountryCode  
    Public PropertyShipToEmail Gets or sets the ShipToEmail  
    Public PropertyShipToFax Gets or sets the ShipToFax  
    Public PropertyShipToFirstName Gets or sets the ShipToFirstName  
    Public PropertyShipToLastName Gets or sets the ShipToLastName  
    Public PropertyShipToPhone Gets or sets the ShipToPhone  
    Public PropertyShipToPostalCode Gets or sets the ShipToPostalCode  
    Public PropertyShipToProvince Gets or sets the ShipToProvince  
    Public PropertyShipToResidence Gets or sets a value indicating whether the ShipToResidence  
    Public PropertySubscriptionId Gets or sets the identity of this entity.  
    Public PropertySubscriptionOrders Gets or sets the SubscriptionOrders  
    Public PropertySubscriptionPlan Gets or sets the SubscriptionPlan  
    Public PropertyTransaction Gets or sets the Transaction  
    Public PropertyTransactionId Gets or sets the Transaction for this entity.  
    Public PropertyUser Gets or sets the User  
    Public PropertyUserGroups Gets or sets the UserGroups  
    Public PropertyUserId Gets or sets the User for this entity.  
    Top
    Public Methods
     NameDescription
    Public MethodActivate Activates this subscription  
    Public MethodDeactivate Deactivates this subscription  
    Public MethodEquals Determines if this object instance is equal to another. (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)
    Public MethodFormatBillAddressOverloaded.  Gets formatted Billing address  
    Public MethodFormatShipAddressOverloaded.  Gets formatted Shipping address  
    Public MethodGetBillingAddress Gets billing address for subscriptions  
    Public MethodGetHashCodeServes as the default hash function. (Inherited from CommerceBuilder.DomainModel.EntityWithTypedId<int>)
    Public MethodGetShippingAddress Gets shipping address for subscriptions  
    Public MethodGetSignatureProperties Gets the signature properties for the class type. (Inherited from CommerceBuilder.DomainModel.BaseObject)
    Public MethodHasSameObjectSignatureAs You may override this method to provide your own comparison routine. (Inherited from CommerceBuilder.DomainModel.BaseObject)
    Public MethodIsExpired Gets a value indicating whether the subscription is expired or not  
    Public MethodIsOrderGenerationDue Gets a value indicating whether next order for this subscription needs to be generated  
    Public MethodIsTransient 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>)
    Public MethodRecalculateExpiration Recalculate expiration date  
    Public MethodRecalculateNextOrderDueDate Recalculates the next order due date for this subscription  
    Public MethodSetBillingAddress Sets shipping address informatoin for subscription  
    Public MethodSetShippingAddress Sets billing address informatoin for subscription  
    Top
    Protected Methods
     NameDescription
    Protected MethodGetTypeSpecificSignatureProperties 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>)
    Protected MethodGetTypeUnproxied

    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
     NameDescription
    Public Extension MethodDelete Delete the entity from the database
    Public Extension MethodSave Save the entity to the database
    Public Extension MethodToQueryStringOverloaded.  Use this method to bulid query string from NameValueCollection
    Top
    See Also

    Reference

    Subscription Class
    CommerceBuilder.Orders Namespace

     

     

    Copyright Able Solutions Corporation 2018-2019.

    Send Feedback