/**
 * Example license header for Java files
 *
 *      http://andromda.sourceforge.net/
 */
//
// Attention: Generated code! Do not modify by hand!
// Generated by SpringServiceBase.vsl in andromda-spring-cartridge on 09/18/2014 17:02:26-0400. Do not modify by hand!.
//
/**
 * TEMPLATE:    SpringServiceBase.vsl in andromda-spring cartridge
 * MODEL CLASS: SpringCartridge How to Model::Spring Example::org.andromda.test::4::RentalService
 * STEREOTYPE:  Service
 */
package org.andromda.test.4;

/**
 * <p>
 * Spring Service base class for <code>org.andromda.test.4.RentalService</code>,
 * provides access to all services and entities referenced by this service.
 * </p>
 *
 * @see org.andromda.test.4.RentalService
 */
public abstract class RentalServiceBase
    implements org.andromda.test.4.RentalService
{
    private org.andromda.test.4.CarDao carDao;

    /**
     * Sets the reference to <code>car</code>'s DAO.
     * @param carDaoIn
     */
    public void setCarDao(org.andromda.test.4.CarDao carDaoIn)
    {
        this.carDao = carDaoIn;
    }

    /**
     * Gets the reference to <code>car</code>'s DAO.
     * @return carDao
     */
    protected org.andromda.test.4.CarDao getCarDao()
    {
        return this.carDao;
    }

    private org.andromda.test.4.PersonDao personDao;

    /**
     * Sets the reference to <code>person</code>'s DAO.
     * @param personDaoIn
     */
    public void setPersonDao(org.andromda.test.4.PersonDao personDaoIn)
    {
        this.personDao = personDaoIn;
    }

    /**
     * Gets the reference to <code>person</code>'s DAO.
     * @return personDao
     */
    protected org.andromda.test.4.PersonDao getPersonDao()
    {
        return this.personDao;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public java.util.List getAllCars()
    {
        try
        {
            return this.handleGetAllCars();
        }
        catch (Throwable th)
        {
            throw new org.andromda.test.4.RentalServiceException(
                "Error performing 'org.andromda.test.4.RentalService.getAllCars()' --> " + th,
                th);
        }
    }

    /**
     * Performs the core logic for {@link #getAllCars()}
     * @return java.util.List
     * @throws Exception
     */
    protected abstract java.util.List handleGetAllCars()
        throws Exception;

    /**
     * {@inheritDoc}
     */
    @Override
    public java.util.List getCustomersByName(final java.lang.String name)
    {
        if (name == null || name.trim().length() == 0)
        {
            throw new IllegalArgumentException(
                "org.andromda.test.4.RentalService.getCustomersByName(java.lang.String name) - 'name' can not be null or empty");
        }
        try
        {
            return this.handleGetCustomersByName(name);
        }
        catch (Throwable th)
        {
            throw new org.andromda.test.4.RentalServiceException(
                "Error performing 'org.andromda.test.4.RentalService.getCustomersByName(java.lang.String name)' --> " + th,
                th);
        }
    }

    /**
     * Performs the core logic for {@link #getCustomersByName(java.lang.String)}
     * @param name java.lang.String TODO: Model Documentation for org.andromda.test.4.RentalService.getCustomersByName(name)
     * @return java.util.List
     * @throws Exception
     */
    protected abstract java.util.List handleGetCustomersByName(java.lang.String name)
        throws Exception;

    /**
     * Gets the current <code>principal</code> if one has been set,
     * otherwise returns <code>null</code>.
     *
     * @return the current principal
     */
    protected java.security.Principal getPrincipal()
    {
        return org.andromda.spring.PrincipalStore.get();
    }

    /**
     * Gets the message source available to this service.
     * @return MessageSource
     */
    protected org.springframework.context.MessageSource getMessages()
    {
        return (org.springframework.context.MessageSource)
            org.andromda.spring.BeanLocator.instance().getBean("messageSource");
    }

    /**
     * Gets the message having the given <code>key</code> in the underlying message bundle.
     *
     * @param key the key of the message in the messages.properties message bundle.
     * @return String
     */
    protected String getMessage(final String key)
    {
        return this.getMessages().getMessage(key, null, null);
    }

    /**
     * Gets the message having the given <code>key</code> and <code>arguments</code> in the
     * underlying message bundle.
     *
     * @param key the key of the message in the messages.properties message bundle.
     * @param arguments any arguments to substitute when resolving the message.
     * @return String
     */
    protected String getMessage(final String key, final Object[] arguments)
    {
        return this.getMessages().getMessage(key, arguments, null);
    }

    /**
     * Gets the message having the given <code>key</code> using the given <code>arguments</code>
     * for the given <code>locale</code>.
     *
     * @param key the key of the message in the messages.properties message bundle.
     * @param arguments any arguments to substitute when resolving the message.
     * @param locale the locale of the messages to retrieve.
     * @return String
     */
    protected String getMessage(
        final String key, final Object[] arguments,
        final java.util.Locale locale)
    {
        return this.getMessages().getMessage(key, arguments, locale);
    }


    /**
     * Gets all roles belonging to the current principal.
     *
     * @return the names of the current principal roles.
     */
    public String[] getPrincipalRoles()
    {
        return org.andromda.spring.PrincipalStore.getPrincipalRoles();
    }

// spring-service-base merge-point
}