diff --git a/designdocs/commerce.pod b/designdocs/commerce.pod index b744a21d2..31124eaa1 100644 --- a/designdocs/commerce.pod +++ b/designdocs/commerce.pod @@ -1651,103 +1651,6 @@ and administrators to manage their transaction history. =back -=head1 SKU (base product class) - -The SKU class is what all other products will be subclassed from. It -needs to be simple so it can be extended to fit any need. - -=head2 Data Dictionary - -The following fields are needed to construct this assets table called -EE<128>E<156>SKUEE<128>E<157>. - -Field - -Schema - -Description - -assetId - -guid - -The unique id assigned to this sku that may never change. It's with all -assets - -sku - -varchar(35) unique - -The unique id that the shop keeper assigns to this item. It may be -changed by the shop keeper. By default this is set equal to assetId. - -vendorId - -guid - -The unique id of the vendor associated with this sku, if any - -=head2 Method Dictionary - -The following methods will be available from the WebGUI::Asset::Sku -class. - -Method - -Description - -asset methods - -all the methods from the WebGUI::Asset superclass - -addToCart - -Adds this sku to the shopping cart. - -applyOptions - -Accepts a configuration data hash reference that can configure a sku a -certain way. For example, EE<128>E<156>a size XL red -t-shirtEE<128>E<157> instead of just EE<128>E<156>a -t-shirtEE<128>E<157>. - -param: options EE<128>E<147> a hash reference containing the -configuration properties returned from getConfiguration() - -getOptions - -Returns a hash reference of configuration data that can return this sku -to a configured state. See applyConfiguration() for details. - -getMaxAllowedInCart - -By default returns 99999999. Should be overridden by subclasses. For -unique items should return 1. For items that have a count in stock, -should return the number that are currently in stock. - -getPrice - -By default return 0.00. Should be overridden by subclasses. - -isShippingRequired - -By default return 0. Should be overridden by subclasses. - -newBySku - -Instanciates based on an existing sku, rather than an assetId. - -param: session EE<128>E<147> a reference to the current session - -param: sku EE<128>E<147> the sku to instanciate - -processStyle - -Looks up the style from the container and and wrappers the product in -it. - -param: html EE<128>E<147> the HTML output to be wrapped by the -style =head1 Donation Asset