voucherheaderservice.java

一个关于tlms的一个小程序 看看能否帮助到别人

/**
 * =============================================
 * Copyright 2006 szmx
 *
 * Change Revision
 * --------------------------------
 *   Date          Author      Remarks
 *   2006-4-14     Allen.Zeng    Create com.szmx.tlms.finance.service.VoucherHeaderService
 * =============================================
 */

package com.szmx.tlms.finance.service;

import com.szmx.tlms.TlmsServiceException;
import com.szmx.tlms.finance.model.VoucherHeader;
import com.szmx.tlms.finance.model.CalendarPeriod;
import com.szmx.framework.base.model.Pagination;
import com.szmx.framework.base.service.BaseService;

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

/**
 *
 * @author Allen.Zeng
 * @since 2006-4-14
 */

public interface VoucherHeaderService extends BaseService {
    /**
     * This method saves a single voucher header object
     *
     * @param companySysId   company physical id
     * @param calendarPeriod  persistent or detached caleandar period object
     * @param voucherHeader  transient voucher header object
     * @throws TlmsServiceException
     */
    void saveVoucherHeader(String companySysId, CalendarPeriod calendarPeriod, VoucherHeader voucherHeader) throws TlmsServiceException;

    /**
     * This method saves voucher header objects in batches
     *
     * @param companySysId  company physical id
     * @param calendarPeriod  persistent or detached calendar period  object
     * @param voucherHeaders  collection of transient voucher header objects
     * @throws TlmsServiceException
     */
    void saveVoucherHeader(String companySysId, CalendarPeriod calendarPeriod, Collection voucherHeaders) throws TlmsServiceException;

    /**
     * This method updates a single voucher header object
     *
     * @param calendarPeriod  persistent or detached calendar period object
     * @param voucherHeader  persistent or detached voucher header object
     * @throws TlmsServiceException
     */
    void updateVoucherHeader(CalendarPeriod calendarPeriod, VoucherHeader voucherHeader) throws TlmsServiceException;

    /**
     * This method updates voucher header objects in batches
     *
     * @param calendarPeriod  persistent or detached calendar period object
     * @param voucherHeaders  collection of persistent or detatched voucher header objects
     * @throws TlmsServiceException
     */
    void updateVoucherHeader(CalendarPeriod calendarPeriod, Collection voucherHeaders) throws TlmsServiceException;

    /**
     * This method removes a single voucher header object
     *
     * @param voucherHeader  persistent or detached voucher header object
     * @throws TlmsServiceException
     */
    void removeVoucherHeader(VoucherHeader voucherHeader) throws TlmsServiceException;

    /**
     * This method removes voucher header objects in batches
     *
     * @param voucherHeaders  collection of persistent or detached voucher header objects
     * @throws TlmsServiceException
     */
    void removeVoucherHeader(Collection voucherHeaders) throws TlmsServiceException;

    /**
     * This method removes voucher header objects in batches through their ids.
     *
     * @param idArr  array of cost voucherHeaders' ids
     * @throws TlmsServiceException
     */
    void removeVoucherHeader(final String[] idArr) throws TlmsServiceException;

    /**
     * This method gets voucher header object by its id
     *
     * @param id  voucher header object physical id
     * @return  voucher header object
     * @throws TlmsServiceException
     */
    VoucherHeader getVoucherHeader(final String id) throws TlmsServiceException;

    /**
     * This method completes user search function with paging
     *
     * @param companySysId  company physical id
     * @param calendarPeriod  transient, persistent or detached calendar persiod object
     * @param voucherHeader  voucher header object
     * @param pagination  pagination object for paging searching
     * @return  pagination object
     * @throws TlmsServiceException
     */
    Pagination searchVoucherHeader(String companySysId, CalendarPeriod calendarPeriod, VoucherHeader voucherHeader, Pagination pagination) throws TlmsServiceException;

    /**
     * This method gets all voucher headers of a company during special period according with some conditions
     *
     * @param companySysId  company physical id
     * @param calendarPeriod  transient, persistent or detached calendar period object
     * @param voucherHeader  voucher header ojbect
     * @return  list of voucher header objects. If nothing, return null
     * @throws TlmsServiceException
     */
    List searchVoucherHeader(String companySysId, CalendarPeriod calendarPeriod, VoucherHeader voucherHeader) throws TlmsServiceException;

    /**
     * This method searches voucher headers of all companies
     *
     * @param calendarPeriod  transient, persistent or detached calendar period object
     * @param voucherHeader  voucher header object
     * @return  list of voucher header objects. If nothing, return null
     * @throws TlmsServiceException
     */
    List searchVoucherHeader(CalendarPeriod calendarPeriod, VoucherHeader voucherHeader) throws TlmsServiceException;
}