OfficeDao.java example

Explorer
head-master
/*
 * 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.office.persistence;

import java.util.Collection;
import java.util.List;

import org.mifos.customers.exceptions.CustomerException;
import org.mifos.customers.office.business.OfficeBO;
import org.mifos.customers.office.business.OfficeLevelEntity;
import org.mifos.customers.office.exceptions.OfficeException;
import org.mifos.customers.office.util.helpers.OfficeLevel;
import org.mifos.dto.domain.OfficeDetailsDto;
import org.mifos.dto.domain.OfficeDto;
import org.mifos.dto.domain.OfficeHierarchyDto;
import org.mifos.dto.domain.OfficeLevelDto;
import org.mifos.security.util.UserContext;

public interface OfficeDao {

    OfficeBO findOfficeById(Short officeId);

    OfficeDto findOfficeDtoById(Short officeId);

    void save(OfficeBO officeBO);

    void save(OfficeLevelEntity entity);

    List<OfficeDto> findAllOffices();

    List<OfficeBO> findBranchsOnlyWithParentsMatching(String searchId);

    List<OfficeDto> findNonBranchesOnlyWithParentsMatching(String searchId);

    List<OfficeDetailsDto> findActiveOfficeLevels();

    OfficeLevelDto findOfficeLevelsWithConfiguration();

    OfficeHierarchyDto headOfficeHierarchy();

    List<String> topLevelOfficeNames(Collection<Short> idList);

    List<OfficeDto> findActiveParents(OfficeLevel officeLevel);

    OfficeLevelEntity retrieveOfficeLevel(OfficeLevel officeLevel);

    void validateOfficeNameIsNotTaken(String officeName) throws OfficeException;

    void validateOfficeShortNameIsNotTaken(String shortName) throws OfficeException;

    void validateNoActiveChildrenExist(Short officeId) throws OfficeException;

    void validateNoActivePeronnelExist(Short officeId) throws OfficeException;

    void validateBranchIsActiveWithNoActivePersonnel(Short officeId, UserContext userContext) throws CustomerException;

    void validateNoOfficesExistGivenOfficeLevel(OfficeLevel regionaloffice);

    List<OfficeDetailsDto> findActiveBranches(Short branchId);
}