com.softslate.commerce.businessobjects.core
Interface BusinessObjectUtils

All Known Implementing Classes:

BusinessObjectUtilsImpl

public interface BusinessObjectUtils

Interface for a utility object containing various methods used by BusinessProcessors in performing business logic.

Each BusinessProcessors is able to retrieve an instance of BusinessObjectUtils by calling its utils method.

The default "businessObjectUtilsImplementer" is BusinessObjectUtilsImpl.

Author:

David Tobey

Method Summary

java.lang.String	formatDateTime(java.util.Date dateTime) Formats a Date object into a string suitable for storage in the database.
java.lang.String	formatPrice(double rawPrice, java.lang.String currencyCode, java.util.Locale locale) Formats a double into a string suitable for displaying the double as a price.
java.lang.String	formatPrice(java.lang.Double rawPrice, java.lang.String currencyCode, java.util.Locale locale) Formats a Double into a string suitable for displaying the double as a price, or a price representing 0 if the Double is null.
java.util.Collection	getMapsFromBeans(java.util.Collection beans) Given a collection of bean objects returns a collection of Maps describing each bean's properties.
org.w3c.dom.Document	parse(java.io.InputStream xmlStream, boolean ignoreWhitespace) Returns a DOM Level2 document that represents the given document.
java.util.Date	parseDateTime(java.lang.String dateTime) Parses a string (typically taken from a database query) into a Date object.
org.w3c.dom.Node	parsePartialDocument(java.lang.String xml) Parses a section of XML and returns the first Element node found
java.util.Map	parseResponseData(java.lang.String response) Parses a query string of name value pairs into a Map.
java.lang.String	prepareRequestData(java.util.Map params, boolean urlEncode) Prepares a string, which may optionally be url-encoded, for use with an HTTP request, given a map of the request's parameters.
java.lang.String	sendHTTPPost(java.lang.String urlString, java.lang.String postData, boolean followRedirect) Sends an HTTP request using the POST method to a given URL.

Method Detail

formatDateTime

java.lang.String formatDateTime(java.util.Date dateTime)

Formats a Date object into a string suitable for storage in the database.

Parameters:

dateTime -

Returns:

a String in the form of "yyyy-MM-dd HH:mm:ss:SSS" suitable for storage in the database.

parseDateTime

java.util.Date parseDateTime(java.lang.String dateTime)

Parses a string (typically taken from a database query) into a Date object.

Parameters:

dateTime -

Returns:

a String in the form of "yyyy-MM-dd HH:mm:ss:SSS" suitable for storage in the database.

formatPrice

java.lang.String formatPrice(java.lang.Double rawPrice,
                             java.lang.String currencyCode,
                             java.util.Locale locale)

Formats a Double into a string suitable for displaying the double as a price, or a price representing 0 if the Double is null.

Parameters:

rawPrice -

currencyCode -

locale -

Returns:

a String suitable for displaying the double as a price.

formatPrice

java.lang.String formatPrice(double rawPrice,
                             java.lang.String currencyCode,
                             java.util.Locale locale)

Formats a double into a string suitable for displaying the double as a price.

Parameters:

rawPrice -

currencyCode -

locale -

Returns:

a String suitable for displaying the double as a price.

prepareRequestData

java.lang.String prepareRequestData(java.util.Map params,
                                    boolean urlEncode)
                                    throws java.lang.Exception

Prepares a string, which may optionally be url-encoded, for use with an HTTP request, given a map of the request's parameters.

Parameters:

params - A Map of key-value String pairs representing the parameters of the request.

urlEncode - If true, the keys and values in the string will be url-encoded.

Returns:

A String representing a valid URL-encoded query string.

Throws:

java.lang.Exception

parseResponseData

java.util.Map parseResponseData(java.lang.String response)
                                throws java.lang.Exception

Parses a query string of name value pairs into a Map.

Parameters:

response - A String key-value pairs in the form of a URL query string

Returns:

A Map representing the query string.

Throws:

java.lang.Exception

sendHTTPPost

java.lang.String sendHTTPPost(java.lang.String urlString,
                              java.lang.String postData,
                              boolean followRedirect)
                              throws java.lang.Exception

Sends an HTTP request using the POST method to a given URL.

Parameters:

urlString - The URL to send the request to.

postData - A String representing a valid URL-encoded query string.

followRedirect - A boolean indicating whether redirects should be followed.

Returns:

A String representing the server's response, or the Location header if redirects are not to be followed.

Throws:

java.lang.Exception

getMapsFromBeans

java.util.Collection getMapsFromBeans(java.util.Collection beans)

Given a collection of bean objects returns a collection of Maps describing each bean's properties.

Parameters:

beans -

Returns:

A Collection of Maps describing the beans.

parse

org.w3c.dom.Document parse(java.io.InputStream xmlStream,
                           boolean ignoreWhitespace)
                           throws javax.xml.parsers.ParserConfigurationException,
                                  org.xml.sax.SAXException,
                                  java.io.IOException

Returns a DOM Level2 document that represents the given document.

Parameters:

xmlStream - An InputStream that is the source of the XML data

ignoreWhitespace - This is passed through to the DocumentBuilder.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

parsePartialDocument

org.w3c.dom.Node parsePartialDocument(java.lang.String xml)
                                      throws javax.xml.parsers.ParserConfigurationException,
                                             org.xml.sax.SAXException,
                                             java.io.IOException

Parses a section of XML and returns the first Element node found

Parameters:

xml - The XML to be parsed in String form

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException