org.jrimum.domkee.banco.IAgencia Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bpp-cobranca Show documentation

This is a fork and merge from JRimum ( http://www.jrimum.org ), - Bopepo: https://github.com/jrimum/bopepo - Texgit: https://github.com/jrimum/texgit - Valia: https://github.com/jrimum/vallia - Utilix: https://github.com/jrimum/utilix - Domkee: https://github.com/jrimum/domkee For Brazillian Boleto Payment Method. So much thanks for original authors: Gilmar P. S. L, Misael Barreto and Rômulo Augusto.

The newest version!

/* 
 * Copyright 2008 JRimum Project
 * 
 * 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.
 * 
 * Created at: 04/04/2009 - 16:36:30
 *
 * ================================================================================
 *
 * Direitos autorais 2008 JRimum Project
 *
 * Licenciado sob a Licença Apache, Versão 2.0 ("LICENÇA"); você não pode 
 * usar esse arquivo exceto em conformidade com a esta LICENÇA. Você pode obter uma 
 * cópia desta LICENÇA em http://www.apache.org/licenses/LICENSE-2.0 A menos que 
 * haja exigência legal ou acordo por escrito, a distribuição de software sob esta 
 * LICENÇA se dará “COMO ESTÁ”, SEM GARANTIAS OU CONDIÇÕES DE QUALQUER TIPO, sejam 
 * expressas ou tácitas. Veja a LICENÇA para a redação específica a reger permissões 
 * e limitações sob esta LICENÇA.
 * 
 * Criado em: 04/04/2009 - 16:36:30
 * 
 */
package org.jrimum.domkee.banco;


/**
 * 
 * 
 * Define o contrato para classes Agencia. Esse contrato é baseado na especificação FEBRABAN:
 * 
 * 
 * Invariantes:
 * 

 * Código: deve ser um inteiro natural (incluindo zero) entre 1 e 5 dígitos
 * Dígito Verificador: alpha-numérico sendo um inteiro natural (incluindo zero)
 * ou caracter não vazio (' ') com um dígito.
 * 
 * 
 * 
 * @author Gilmar P.S.L. 
 * @author Rômulo Augusto
 * 
 * @version 0.2
 */
public interface IAgencia{

	/**
	 * @return Número da agência
	 */
	C getCodigo();
	
	/**
	 * @return Dígito verificador
	 */
	D getDigitoVerificador();
}