CheckListBO.java

/*
 * Copyright (c) 2005-2011 Grameen Foundation USA
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * See also http://www.apache.org/licenses/LICENSE-2.0.html for an
 * explanation of the license and how it is applied.
 */

package org.mifos.customers.checklist.business;

import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import org.apache.commons.lang.StringUtils;
import org.mifos.customers.checklist.exceptions.CheckListException;
import org.mifos.customers.checklist.persistence.CheckListPersistence;
import org.mifos.customers.checklist.util.helpers.CheckListConstants;
import org.mifos.customers.checklist.util.helpers.CheckListType;
import org.mifos.framework.business.AbstractBusinessObject;
import org.mifos.framework.exceptions.PersistenceException;
import org.mifos.framework.util.DateTimeService;

public abstract class CheckListBO extends AbstractBusinessObject {

    private final Short checklistId;
    private String checklistName;
    private Short checklistStatus;
    private Set<CheckListDetailEntity> checklistDetails;
    private Short supportedLocales;

    protected CheckListBO() {
        this.checklistId = null;
        checklistDetails = new LinkedHashSet<CheckListDetailEntity>();

    }

    protected CheckListBO(String checkListName, Short checkListStatus, List<String> details, Short localeId,
            Short userId) throws CheckListException {
        setCreateDetails(userId, new DateTimeService().getCurrentJavaDateTime());
        this.checklistId = null;

        if (details.size() > 0) {
            setCheckListDetails(details, localeId);
        } else {
            throw new CheckListException(CheckListConstants.CHECKLIST_CREATION_EXCEPTION);
        }
        if (checkListName != null) {
            this.checklistName = checkListName;
        } else {
            throw new CheckListException(CheckListConstants.CHECKLIST_CREATION_EXCEPTION);
        }
        this.checklistStatus = checkListStatus;
        this.supportedLocales = localeId;
    }

    public Short getChecklistId() {
        return checklistId;
    }

    public String getChecklistName() {
        return this.checklistName;
    }

    @SuppressWarnings("unused")
    // see .hbm.xml file
    private void setChecklistName(String checklistName) {
        this.checklistName = checklistName;
    }

    public Short getChecklistStatus() {
        return this.checklistStatus;
    }

    @SuppressWarnings("unused")
    // see .hbm.xml file
    private void setChecklistStatus(Short checklistStatus) {
        this.checklistStatus = checklistStatus;
    }

    public Set<CheckListDetailEntity> getChecklistDetails() {
        return this.checklistDetails;

    }

    @SuppressWarnings("unused")
    // see .hbm.xml file
    private void setChecklistDetails(Set<CheckListDetailEntity> checklistDetailSet) {
        this.checklistDetails = checklistDetailSet;
    }

    public Short getSupportedLocales() {
        return this.supportedLocales;
    }

    @SuppressWarnings("unused")
    // see .hbm.xml file
    private void setSupportedLocales(Short supportedLocales) {
        this.supportedLocales = supportedLocales;
    }

    public void addChecklistDetail(CheckListDetailEntity checkListDetailEntity) {
        checklistDetails.add(checkListDetailEntity);
    }

    protected CheckListPersistence getCheckListPersistence() {
        return new CheckListPersistence();
    }

    private void setCheckListDetails(List<String> details, Short locale) {
        checklistDetails = new HashSet<CheckListDetailEntity>();
        for (String detail : details) {
            CheckListDetailEntity checkListDetailEntity = new CheckListDetailEntity(detail, Short.valueOf("1"), this,
                    locale);
            checklistDetails.add(checkListDetailEntity);
        }
    }

    public abstract CheckListType getCheckListType();

    protected void update(String checkListName, Short checkListStatus, List<String> details, Short localeId,
            Short userId) throws CheckListException {
        setUpdateDetails(userId);
        if (details == null || details.size() <= 0) {
            throw new CheckListException(CheckListConstants.CHECKLIST_CREATION_EXCEPTION);
        }
        if (StringUtils.isBlank(checkListName)) {
            throw new CheckListException(CheckListConstants.CHECKLIST_CREATION_EXCEPTION);
        }
        this.checklistName = checkListName;
        getChecklistDetails().clear();
        for (String detail : details) {
            CheckListDetailEntity checkListDetailEntity = new CheckListDetailEntity(detail, Short.valueOf("1"), this,localeId);
            getChecklistDetails().add(checkListDetailEntity);
        }
        this.checklistStatus = checkListStatus;
        this.supportedLocales = localeId;
    }

    protected void validateCheckListState(Short masterTypeId, Short stateId, boolean isCustomer)
            throws CheckListException {
        try {
            Long records = getCheckListPersistence().isValidCheckListState(masterTypeId, stateId, isCustomer);
            if (records.intValue() != 0) {
                throw new CheckListException(CheckListConstants.EXCEPTION_STATE_ALREADY_EXIST);
            }
        } catch (PersistenceException pe) {
            throw new CheckListException(pe);
        }
    }
}