org.opencrx.application.shop1.cci2
Interface ShopService

All Known Subinterfaces:

ShopService

All Known Implementing Classes:

ShopServiceImpl

public interface ShopService

Class ShopService

Method Summary

AddActivityFollowUpResult	addActivityFollowUp(AddActivityFollowUpParams in) Add a follow up to the specified activity.
AddCustomerToCustomerContractResult	addCustomerToCustomerContract(AddCustomerToCustomerContractParams in) Add customer to the specified customer contract.
AddDeliveryInformationResult	addDeliveryInformation(AddDeliveryInformationParams in) Adds a delivery information record to the specified contract position.
AddSalesOrderPositionResult	addSalesOrderPosition(AddSalesOrderPositionParams in) Add item to sales order.
CancelInvoiceResult	cancelInvoice(CancelInvoiceParams in) Set cancelOn for specified invoice.
CancelSalesOrderResult	cancelSalesOrder(CancelSalesOrderParams in) Set cancelOn for specified sales order.
CreateActivityResult	createActivity(CreateActivityParams in) Creates a new activity.
CreateCustomerAsContactResult	createCustomerAsContact(CreateCustomerAsContactParams in) Create a new customer as contact.
CreateCustomerAsLegalEntityResult	createCustomerAsLegalEntity(CreateCustomerAsLegalEntityParams in) Create a new customer as legal entity.
CreateCustomerContractResult	createCustomerContract(CreateCustomerContractParams in) Create a customer contract.
CreateInvoiceResult	createInvoice(CreateInvoiceParams in) Create a new invoice.
CreateInvoiceFromInvoiceResult	createInvoiceFromInvoice(CreateInvoiceFromInvoiceParams in) Create an invoice based on an invoice.
CreateInvoiceFromSalesOrderResult	createInvoiceFromSalesOrder(CreateInvoiceFromSalesOrderParams in) Create an invoice based on a sales order.
CreateProductClassificationResult	createProductClassification(CreateProductClassificationParams in) Create new product classifications.
CreateProductsResult	createProducts(CreateProductsParams in) Create products.
CreateSalesOrderResult	createSalesOrder(CreateSalesOrderParams in) Create a new sales order.
GetActivitiesByQueryResult	getActivitiesByQuery(GetActivitiesByQueryParams in) Return activities matching the specified query.
GetActivityResult	getActivity(GetActivityParams in) Get activity with the specified activity number.
GetCodeValueContainerResult	getCodeValueContainer(GetCodeValueContainerParams in) Get specified code value containers.
GetCredentialsResult	getCredentials(GetCredentialsParams in) Get credentials for the specified customer.
GetCredentialsByEmailAddressResult	getCredentialsByEmailAddress(GetCredentialsByEmailAddressParams in)
GetCustomerResult	getCustomer(GetCustomerParams in) Get customer data.
GetCustomersByQueryResult	getCustomersByQuery(GetCustomersByQueryParams in) Query customers and return customer numbers of matching customers.
GetDocumentsResult	getDocuments(GetDocumentsParams in) Get documents of the specified document folder.
GetInvoiceResult	getInvoice(GetInvoiceParams in) Get invoice with the specified invoice number.
GetInvoicePositionsResult	getInvoicePositions(GetInvoicePositionsParams in) Collect all positions from all invoices with invoice status greater or equal to the supplied invoice status threshold.
GetInvoicesResult	getInvoices(GetInvoicesParams in) Returns all invoices for the customer.
GetPriceLevelResult	getPriceLevel(GetPriceLevelParams in) Get price levels.
GetProductConfigurationTypesResult	getProductConfigurationTypes(GetProductConfigurationTypesParams in) Return all product configuration types.
GetProductPricesResult	getProductPrices(GetProductPricesParams in) Get price of a product for the specified pricing date and currency.
GetProductsResult	getProducts(GetProductsParams in) Return a product.
GetProductsByQueryResult	getProductsByQuery(GetProductsByQueryParams in) Get products matching the product query.
GetSalesOrderResult	getSalesOrder(GetSalesOrderParams in) Returns a sales order.
GetSalesOrderPositionsResult	getSalesOrderPositions(GetSalesOrderPositionsParams in)
GetSalesOrdersResult	getSalesOrders(GetSalesOrdersParams in) Returns the sales orders for the customer.
SendEMailResult	sendEMail(SendEMailParams in)
SetCredentialsResult	setCredentials(SetCredentialsParams in) Sets the credentials for the specified customer.
SetCustomerContractStatusResult	setCustomerContractStatus(SetCustomerContractStatusParams in)
SetCustomerStatusResult	setCustomerStatus(SetCustomerStatusParams in) Set the customer's status.
SetInvoiceStatusResult	setInvoiceStatus(SetInvoiceStatusParams in) Set the status of an invoice.
SetProductStatusResult	setProductStatus(SetProductStatusParams in) Set the status of the specified product.
SetSalesOrderPositionQuantityResult	setSalesOrderPositionQuantity(SetSalesOrderPositionQuantityParams in) Set quantity of an ordered item.
SetSalesOrderStatusResult	setSalesOrderStatus(SetSalesOrderStatusParams in) Set the status of a sales order.
UpdateCustomerResult	updateCustomer(UpdateCustomerParams in) Update customer data.
UpdateCustomerContractResult	updateCustomerContract(UpdateCustomerContractParams in)
UpdateProductResult	updateProduct(UpdateProductParams in) Update product data.

Method Detail

addActivityFollowUp

AddActivityFollowUpResult addActivityFollowUp(AddActivityFollowUpParams in)

Add a follow up to the specified activity.

Parameters:

name - name of the follow up.

description - description of the follow up.

transitionName - transition with the given name is applied to the activity.

reportingCustomerNumber - customer number of the reporting contact.

addCustomerToCustomerContract

AddCustomerToCustomerContractResult addCustomerToCustomerContract(AddCustomerToCustomerContractParams in)

Add customer to the specified customer contract. A customer can be assigned to at most one customer contract. The assignment is added to the customer contract as account assignment.

Parameters:

customerNumber - number of the customer.

customerContractNumber - number of the customer contract.

addDeliveryInformation

AddDeliveryInformationResult addDeliveryInformation(AddDeliveryInformationParams in)

Adds a delivery information record to the specified contract position.

Parameters:

contractNumber - contract number.

positionNumber - position number.

deliveryInformation - deliveryInformation to be added to the position.

addSalesOrderPosition

AddSalesOrderPositionResult addSalesOrderPosition(AddSalesOrderPositionParams in)

Add item to sales order. If a sales order position with the specified product exists, then the position quantity is incremented by quantity. If no position exists, a new position is created. After the update the sales order is recalculated.

Parameters:

salesOrderNumber - number of the sales order.

quantity - number of items to be added to the sales order.

productNumber - product number.

Returns:

updated and recalculated sales order.

cancelInvoice

CancelInvoiceResult cancelInvoice(CancelInvoiceParams in)

Set cancelOn for specified invoice. The state of the invoice is not changed. If the cancelOn date is set, the customer does not supposed to consume services starting from this date.

Parameters:

invoiceNumber - number of invoice.

cancelOn - cancellation date.

cancelSalesOrder

CancelSalesOrderResult cancelSalesOrder(CancelSalesOrderParams in)

Set cancelOn for specified sales order. The state of the sales order is not changed. If the cancelOn date is set, the customer does not intend to order any products.

Parameters:

salesOrderNumber - number of sales order.

cancelOn - cancellation date.

createActivity

CreateActivityResult createActivity(CreateActivityParams in)

Creates a new activity.

Parameters:

name - activity name.

description - activity description.

detailedDescription - activity detailed description.

reportingCustomerNumber - customer number of the reporting contact.

scheduledStart - activity scheduled start.

scheduledEnd - activity scheduled end.

dueBy - activity due by.

activityCreatorName - activity is created with the specified activity creator.

priority - activity priority.

createCustomerAsContact

CreateCustomerAsContactResult createCustomerAsContact(CreateCustomerAsContactParams in)

Create a new customer as contact. The supplied customerId, userName and emailAddress (optional) must be unique, i.e. no two customers may have the same customerId, userName or emailAddress (optional).

Error status:

• DUPLICATE_CUSTOMER_ID
• DUPLICATE_USERNAME
• DUPLICATE_EMAILADDRESS

Parameters:

customer - customer main data.

Returns:

validated and updated customer main data.

createCustomerAsLegalEntity

CreateCustomerAsLegalEntityResult createCustomerAsLegalEntity(CreateCustomerAsLegalEntityParams in)

Create a new customer as legal entity. The supplied legalName must be unique, i.e. no two customers may have the same legalName.

Parameters:

customer - customer main data.

Returns:

validated and updated customer main data.

createCustomerContract

CreateCustomerContractResult createCustomerContract(CreateCustomerContractParams in)

Create a customer contract. The customer contract holds information which is required to create sales orders and invoices, i.e. the operations createInvoice() and createSalesOrders() require that a customer contract exists for the customer.

createInvoice

CreateInvoiceResult createInvoice(CreateInvoiceParams in)

Create a new invoice.

Parameters:

invoice - invoice to be created.

noPricing - if true, the positions are not priced, i.e. the discount for all positions is set to discountIsPercentage=true, discount=100.

createInvoiceFromInvoice

CreateInvoiceFromInvoiceResult createInvoiceFromInvoice(CreateInvoiceFromInvoiceParams in)

Create an invoice based on an invoice. The origin of the newly created invoice is set to the existing invoice.

Parameters:

invoiceNumber - number of invoice which serves as template for the creation of the invoice.

invoiceStatus: - status of the newly created invoice.

Returns:

created and recalculated invoice.

createInvoiceFromSalesOrder

CreateInvoiceFromSalesOrderResult createInvoiceFromSalesOrder(CreateInvoiceFromSalesOrderParams in)

Create an invoice based on a sales order. The origin of the newly created invoice is set to the sales order.

Parameters:

salesOrderNumber - number of sales order which serves as template for the creation of the invoice.

Returns:

created and recalculated invoice.

createProductClassification

CreateProductClassificationResult createProductClassification(CreateProductClassificationParams in)

Create new product classifications.

Parameters:

classification - list of product classifications.

createProducts

CreateProductsResult createProducts(CreateProductsParams in)

Create products. After import the prices of existing products are recalculated and initial the prices of new products are created. Existing products are updated.

createSalesOrder

CreateSalesOrderResult createSalesOrder(CreateSalesOrderParams in)

Create a new sales order. In addition, a corresponding 'sales process activity' is created. The sales process activity allows to track the life-cycle of the sales process starting from the sales order and ending with the payment of the invoice. The created quote is linked to this activity an vice-versa. Default values for salesTax, billing provider, etc. are taken from the customer contract.

Parameters:

salesOrder - sales order to be created.

Returns:

the created and recalculated sales order.

getActivitiesByQuery

GetActivitiesByQueryResult getActivitiesByQuery(GetActivitiesByQueryParams in)

Return activities matching the specified query.

Parameters:

customerNumber - activities of the specified customer are returned. This parameter is required.

percentCompleteThreshold - if supplied, only activities with percentComplete >= threshold are returned.

Returns:

activities matching the query.

getActivity

GetActivityResult getActivity(GetActivityParams in)

Get activity with the specified activity number.

Parameters:

activityNumber - activity number.

Returns:

activity matching the activity number.

getCodeValueContainer

GetCodeValueContainerResult getCodeValueContainer(GetCodeValueContainerParams in)

Get specified code value containers.

Parameters:

containerName - list of code value container names, i.e. CodeValueContainerT::name (--> CodeValueContainer::name)

rootContainers - if true, code value containers are retrieved from the segment 'Root', otherwise from the configured adapter segment.

Returns:

list of code value containers.

getCredentials

GetCredentialsResult getCredentials(GetCredentialsParams in)

Get credentials for the specified customer.

Parameters:

customerNumber - customer number.

Returns:

credentials.

getCredentialsByEmailAddress

GetCredentialsByEmailAddressResult getCredentialsByEmailAddress(GetCredentialsByEmailAddressParams in)

getCustomer

GetCustomerResult getCustomer(GetCustomerParams in)

Get customer data.

Parameters:

customerId - customer id.

Returns:

customer data.

getCustomersByQuery

GetCustomersByQueryResult getCustomersByQuery(GetCustomersByQueryParams in)

Query customers and return customer numbers of matching customers.

Parameters:

emailAddressHome - optional. If specified the home email address of the customer must match.

Returns:

customer numbers.

getDocuments

GetDocumentsResult getDocuments(GetDocumentsParams in)

Get documents of the specified document folder.

Parameters:

folderName - name of the document folder.

Returns:

documents which are assigned to the specified folder.

getInvoice

GetInvoiceResult getInvoice(GetInvoiceParams in)

Get invoice with the specified invoice number.

Parameters:

invoiceNumber - invoice number.

Returns:

invoice.

getInvoicePositions

GetInvoicePositionsResult getInvoicePositions(GetInvoicePositionsParams in)

Collect all positions from all invoices with invoice status greater or equal to the supplied invoice status threshold.

Parameters:

customerNumber - customer number.

invoiceStatusThreshold - status of invoice must be greater or equal to invoice status threshold.

getInvoices

GetInvoicesResult getInvoices(GetInvoicesParams in)

Returns all invoices for the customer.

Parameters:

customerNumber - customer number.

Returns:

list of invoices.

getPriceLevel

GetPriceLevelResult getPriceLevel(GetPriceLevelParams in)

Get price levels.

Parameters:

priceLevel - name of price level to retrieve.

getProductConfigurationTypes

GetProductConfigurationTypesResult getProductConfigurationTypes(GetProductConfigurationTypesParams in)

Return all product configuration types.

Returns:

product configuration types.

getProductPrices

GetProductPricesResult getProductPrices(GetProductPricesParams in)

Get price of a product for the specified pricing date and currency. The default pricing rule is applied.

Parameters:

productNumber - product number.

pricingDate - pricing date. Default value is the current time.

priceCurrency - price currency.

customerNumber - if specified and available, customer-specific prices are returned.

quantity - if specified and available, quantity-specific prices are returned.

salesTaxType - if specified, the prices are returned including the sales tax, i.e. ProductPriceT.price = price without tax, ProductPriceT.priceIncludingTax = price including tax. If not specified ProductPriceT.price = ProductPrice.priceIncludingTax.

getProducts

GetProductsResult getProducts(GetProductsParams in)

Return a product.

Parameters:

productNumber - list of product numbers.

returnPictureContent - if true, the product picture is returned.

Returns:

list of products.

getProductsByQuery

GetProductsByQueryResult getProductsByQuery(GetProductsByQueryParams in)

Get products matching the product query.

Parameters:

classificationId - product must be member of at least one of the classifications.

productStatus - product must have product status.

getSalesOrder

GetSalesOrderResult getSalesOrder(GetSalesOrderParams in)

Returns a sales order.

Parameters:

salesOrderNumber - number of a sales order.

Returns:

sales order.

getSalesOrderPositions

GetSalesOrderPositionsResult getSalesOrderPositions(GetSalesOrderPositionsParams in)

getSalesOrders

GetSalesOrdersResult getSalesOrders(GetSalesOrdersParams in)

Returns the sales orders for the customer.

Parameters:

customerNumber - customer id.

Returns:

list of sales orders.

sendEMail

SendEMailResult sendEMail(SendEMailParams in)

setCredentials

SetCredentialsResult setCredentials(SetCredentialsParams in)

Sets the credentials for the specified customer.

setCustomerContractStatus

SetCustomerContractStatusResult setCustomerContractStatus(SetCustomerContractStatusParams in)

setCustomerStatus

SetCustomerStatusResult setCustomerStatus(SetCustomerStatusParams in)

Set the customer's status. In addition a follow up is performed on the customer's life-cycle activity which reflects the status change.

Parameters:

customerId - customer id.

status - new status of the customer.

Returns:

previous status of the customer.

setInvoiceStatus

SetInvoiceStatusResult setInvoiceStatus(SetInvoiceStatusParams in)

Set the status of an invoice. paymentDate of the contract is set if the status is set to INVOICE_STATE_PAID.

Parameters:

invoiceNumber - number of the sales order.

status - the new invoice status.

Returns:

the previous invoice status.

setProductStatus

SetProductStatusResult setProductStatus(SetProductStatusParams in)

Set the status of the specified product.

setSalesOrderPositionQuantity

SetSalesOrderPositionQuantityResult setSalesOrderPositionQuantity(SetSalesOrderPositionQuantityParams in)

Set quantity of an ordered item. The sales order is recalculated after updating the position. If the quantity is 0 the position is removed.

Parameters:

salesOrderNumber - number of the quote.

quantity - new quantity.

productNumber - product number.

Returns:

updated and recalculated sales order.

setSalesOrderStatus

SetSalesOrderStatusResult setSalesOrderStatus(SetSalesOrderStatusParams in)

Set the status of a sales order.

Parameters:

salesOrderNumber - number of the sales order.

status - the new sales order status.

Returns:

the the old sales order status.

updateCustomer

UpdateCustomerResult updateCustomer(UpdateCustomerParams in)

Update customer data. If updateAddressData is true the following addresses are updated:

• postalAddressHome
• postalAddressBusiness
• emailAddressHome
• emailAddressBusiness
• faxNumberHome
• faxNumberBusiness
• phoneNumberHome
• phoneNumberBusiness
• phoneNumberMobile
• webAddressHome
• webAddressBusiness
• messengerAddress
• blogAddress

Parameters:

customer - customer main data to be updated.

Returns:

customer main data before modification.

updateCustomerContract

UpdateCustomerContractResult updateCustomerContract(UpdateCustomerContractParams in)

updateProduct

UpdateProductResult updateProduct(UpdateProductParams in)

Update product data. For products with isBundle=true a corresponding product filter is created. The filter properties are set to ProductT::bundleData, i.e. the filter selects the products listed by ProductBundleDataT::member and ProductBundleDataT::classificationIdFilter.

Parameters:

product - product to be updated. Only the parts of the product specified by the corresponding flags are updated.

updateMainData - if true, the main fields of the product are updated.

updateClassification - if true, ProductT::classificationId is updated.

updateUom - if true, ProductT::uom is updated.

updateConfiguration - if true, ProductT::configuration is updated.

updatePicture - if true, ProductT::picture is updated.

updateBundleData - if true, ProductT::bundleData is updated.

updateProductPhase - if true, ProductT::productPhase is updated.