Interface IBasBSSeries
Namespace: IBasBS100
Assembly: IBasBS100.dll
Syntax
[ComVisible(true)]
[Guid("E75A35D6-553D-4C08-A407-2B133EBFE4CA")]
public interface IBasBSSeries
Methods
Actualiza(String, BasBESerie)
Permite a actualização de uma determinada série
Declaration
void Actualiza(string strModulo, BasBESerie objSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
BasBESerie | objSerie | Objecto que contem todas as informações da série a actualizar. |
ActualizaLogSeriesReposicao(String, DateTime, String, String, OrderedDictionary)
Atualiza um log de series após a reposição de um backup
Declaration
void ActualizaLogSeriesReposicao(string Utilizador, DateTime DataReposicao, string IdEventoLog, string IdLog, OrderedDictionary Series = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | Utilizador |
|
System.DateTime | DataReposicao |
|
System.String | IdEventoLog |
|
System.String | IdLog |
|
System.Collections.Specialized.OrderedDictionary | Series |
|
ActualizaNumerador(String, String, String, Int32, DateTime)
efectuar a actualização do numerador de uma determinada série
Declaration
void ActualizaNumerador(string strModulo, string strDocumento, string strSerie, int lngNumDoc, DateTime datDataDoc)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada |
System.String | strSerie | Serie do documento. |
System.Int32 | lngNumDoc | Número para actualizar a numeração. |
System.DateTime | datDataDoc | Data do último documento. |
ActualizaValorAtributo(String, String, String, String, Object)
Permite a actualização de um determinado atributo
Declaration
void ActualizaValorAtributo(string strModulo, string strDocumento, string strSerie, string strAtributo, dynamic varValor)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
System.String | strAtributo | Atributo a actualizar. |
System.Object | varValor | Novo valor do atributo a actualizar. |
ActualizaValorAtributos(String, String, String, StdBECampos)
Permite a actualização de um conjunto de atributos
Declaration
void ActualizaValorAtributos(string strModulo, string strDocumento, string strSerie, StdBECampos Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
StdBECampos | Atributos | Atributos a actualizar. |
DaConfig(String, String, String)
Devolve a configuração do mapa de acordo com a série
Declaration
string DaConfig(string strModulo, string strDocumento, string strSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada. |
System.String | strSerie | Serie do documento. |
Returns
Type | Description |
---|---|
System.String |
DaDefCamposUtil(String)
Devolve as definições dos campos do utilizador.
Declaration
StdBEDefCamposUtil DaDefCamposUtil(string strModulo)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes |
Returns
Type | Description |
---|---|
StdBEDefCamposUtil |
DaPosicaoChave(String, String, BasBESeries)
Dá o índice da chave indicada dentro desta collection, ou -1 se não existe
Declaration
int DaPosicaoChave(string strDocumento, string strSerie, BasBESeries objBeColl)
Parameters
Type | Name | Description |
---|---|---|
System.String | strDocumento | |
System.String | strSerie | |
BasBESeries | objBeColl |
Returns
Type | Description |
---|---|
System.Int32 |
DaProximaOrdem(String, String)
Dá o índice de ordem da próxima série a criar
Declaration
int DaProximaOrdem(string strModulo, string strDocumento)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada. |
Returns
Type | Description |
---|---|
System.Int32 |
DaSerieDefeito(String, String, Object)
Devolve a série por defeito de um determinado documento, numa determinada data.
Se a data não for fornecida, assume a data actual.
As condições pesquisa são as seguintes:
1- Pesquisar por uma série activa, por defeito, contendo a data do documento.
2- Se não encontra, então: Pesquisa por uma série activa, por defeito.
3- Se não encontra, então: Pesquisa por uma série por defeito.
4- Se não encontra, então: Devolve a primeira série que encontra.
Declaration
string DaSerieDefeito(string strModulo, string strDocumento, dynamic datDataDoc = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento para o qual se pretende obter a série por defeito. |
System.Object | datDataDoc | Data do documento. Se não for fornecida, assume a data actual. |
Returns
Type | Description |
---|---|
System.String |
DaSerieDefeitoLista(String, String, ref String, ref Int32, Object, BasBESeries)
Devolve a série por defeito de um determinado documento, numa determinada data.
Se a lista de séries estiver preenchida, procura na lista fornecida; caso contrário, pesquisa na BD.
Devolve a série e a posição da série na lista (com índice base 0).
Se a data não for fornecida, assume a data actual.
As condições pesquisa são as seguintes:
1- Pesquisar por uma série activa, por defeito, contendo a data do documento.
2- Se não encontra, então: Pesquisa por uma série activa, por defeito.
3- Se não encontra, então: Pesquisa por uma série por defeito.
4- Se não encontra, então: Devolve a primeira série que encontra.
Declaration
string DaSerieDefeitoLista(string strModulo, string strDocumento, ref string strSerie, ref int intPosicao, dynamic datDataDoc = null, BasBESeries objListaSeries = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento para o qual se pretende obter a série por defeito. |
System.String | strSerie | Código da Série, a devolver. |
System.Int32 | intPosicao | Posição da Série na lista, a devolver (com índice base 0). |
System.Object | datDataDoc | Data do documento. Se não for fornecida, assume a data actual. |
BasBESeries | objListaSeries | Lista de séries na qual procurar. Se não for fornecida, pesquisa-se na BD. |
Returns
Type | Description |
---|---|
System.String |
DatasValidas(BasBESerie, DateTime)
Devolve se uma determinada data está dentro dos limites de datas
Declaration
bool DatasValidas(BasBESerie objSerie, DateTime datDataDocumento)
Parameters
Type | Name | Description |
---|---|---|
BasBESerie | objSerie | |
System.DateTime | datDataDocumento | Data que se pretende validar. |
Returns
Type | Description |
---|---|
System.Boolean |
DaValorAtributo(String, String, String, String)
Devolve o valor de um determinado atributo
Declaration
dynamic DaValorAtributo(string strModulo, string strDocumento, string strSerie, string strAtributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
System.String | strAtributo | Atributo a devolver. |
Returns
Type | Description |
---|---|
System.Object |
DaValorAtributoLock(String, String, String, String)
Devolve o valor de um determinado atributo
Declaration
dynamic DaValorAtributoLock(string strModulo, string strDocumento, string strSerie, string strAtributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
System.String | strAtributo | Atributo a devolver. |
Returns
Type | Description |
---|---|
System.Object |
DaValorAtributos(String, String, String, String[])
Devolve o valor de um determinado conjunto de atributos
Declaration
StdBECampos DaValorAtributos(string strModulo, string strDocumento, string strSerie, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
System.String[] | Atributos | Atributos a devolver |
Returns
Type | Description |
---|---|
StdBECampos |
DaValorAtributosLock(String, String, String, String[])
Devolve o valor de um determinado conjunto de atributos
Declaration
StdBECampos DaValorAtributosLock(string strModulo, string strDocumento, string strSerie, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
System.String[] | Atributos | Atributos a devolver |
Returns
Type | Description |
---|---|
StdBECampos |
DaValorChave(String, BasBESerie)
Dá o valor da chave na tabela para este registo
Declaration
string DaValorChave(string strModulo, BasBESerie objBE)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | |
BasBESerie | objBE |
Returns
Type | Description |
---|---|
System.String |
Edita(String, String, String)
Permite a edição de uma determinada série. Devolve um objecto com as informações da série
Declaration
BasBESerie Edita(string strModulo, string strDocumento, string strSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
Returns
Type | Description |
---|---|
BasBESerie |
Existe(String, String, String)
Identifica se uma determinada serie existe
Declaration
bool Existe(string strModulo, string strDocumento, string strSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
Returns
Type | Description |
---|---|
System.Boolean |
ExisteReposicaoBackUP()
Valida a existência de reposição de backup
Declaration
bool ExisteReposicaoBackUP()
Returns
Type | Description |
---|---|
System.Boolean |
ExisteReposicaoBackUP(ref StdBEValoresStr)
Valida a existência de reposição de backup
Declaration
bool ExisteReposicaoBackUP(ref StdBEValoresStr ValoresDevolvidos)
Parameters
Type | Name | Description |
---|---|---|
StdBEValoresStr | ValoresDevolvidos |
|
Returns
Type | Description |
---|---|
System.Boolean |
LimitesValidos(String, String, String, Int32)
Devolve se um determinado numero está dentro dos limites da numeração
Declaration
bool LimitesValidos(string strModulo, string strDocumento, string strSerie, int lngNumero)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada |
System.String | strSerie | Serie do documento. |
System.Int32 | lngNumero | Numero que se pretende validar. |
Returns
Type | Description |
---|---|
System.Boolean |
LimpaSeriesPorDefeito(String, String, DateTime, DateTime)
Remove a indicação das séries por defeito de um determinado documento
Declaration
void LimpaSeriesPorDefeito(string strModulo, string strTipoDoc, DateTime datDataInicial, DateTime datDataFinal)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strTipoDoc | Documento a actualizar |
System.DateTime | datDataInicial | Data inicial na qual se limpam as séries por defeito. |
System.DateTime | datDataFinal | Data final na qual se limpam as séries por defeito. |
ListaSeries(String, String, Boolean)
Permite listar todas as séries de um determinado documento activas ou inactivas. A lista é ordenada pelo campo Serie.
Declaration
BasBESeries ListaSeries(string strModulo, string strDocumento, bool blnVerInactivas)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual as séries deverão estar associadas. |
System.Boolean | blnVerInactivas | Identifica se se pretende obter todas as séries activas |
Returns
Type | Description |
---|---|
BasBESeries |
ProximoNumero(String, String, String, Boolean)
Devolve o proximo numero da série
Declaration
int ProximoNumero(string strModulo, string strDocumento, string strSerie, bool blnLockRegisto = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada. |
System.String | strSerie | Série para a qual se pretende saber o numero seguinte. |
System.Boolean | blnLockRegisto | Colocar um lock no registo? |
Returns
Type | Description |
---|---|
System.Int32 |
Remove(String, String, String)
Permite a remoção de uma determinada série
Declaration
void Remove(string strModulo, string strDocumento, string strSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo que chama esta opção. |
System.String | strDocumento | Código do documento. |
System.String | strSerie | Série de documento a pesquisar. |
RemoveSeries(String, String)
Permite Remover todas as séries de um determinado documento
Declaration
void RemoveSeries(string strModulo, string strDocumento)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual as séries deverão estar associadas. |
SerieInactiva(String, String, String)
Devolve se uma determinada série está inactiva
Declaration
bool SerieInactiva(string strModulo, string strDocumento, string strSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada. |
System.String | strSerie | Serie para a qual se pretende saber o estado. |
Returns
Type | Description |
---|---|
System.Boolean |
SeriePresenteEmLogReposicao(String, String, String)
Verifica se a série está referênciada no log das reposições
Declaration
bool SeriePresenteEmLogReposicao(string Modulo, string TipoDoc, string Serie)
Parameters
Type | Name | Description |
---|---|---|
System.String | Modulo | |
System.String | TipoDoc | |
System.String | Serie |
Returns
Type | Description |
---|---|
System.Boolean |
SerieReferenciada(String, String, String)
Devolve True caso a série já esteja em uso, False caso a série ainda não tenha movimentos
Declaration
bool SerieReferenciada(string strModulo, string strDocumento, string strSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada |
System.String | strSerie | Serie do documento. |
Returns
Type | Description |
---|---|
System.Boolean |
SugereDataDocumento(String, String, String)
Devolve a data sugerida pela série para o documento
Declaration
DateTime SugereDataDocumento(string strModulo, string strDocumento, string strSerie)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada. |
System.String | strSerie | Serie do documento. |
Returns
Type | Description |
---|---|
System.DateTime |
SugereDataDocumento2(String, String, String, DateTime)
Se a série está configurada para sugerir data de sistema, sugere esta;
Senão, sugere o valor por defeito fornecido.
Declaration
DateTime SugereDataDocumento2(string strModulo, string strDocumento, string strSerie, DateTime dtData)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual a série está associada. |
System.String | strSerie | Serie do documento. |
System.DateTime | dtData | Data do documento para ser devolvida caso o sugere data sistema esteja inactivo. |
Returns
Type | Description |
---|---|
System.DateTime |
ValidaActualizacao(BasBESerie, ref String)
Permite efectuar a validação da série a actualizar
Declaration
bool ValidaActualizacao(BasBESerie objSerie, ref string strErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
BasBESerie | objSerie | Objecto que contem todas as informações da série a actualizar. |
System.String | strErroValidacao | Devolve os erros encontrados durante a validação. |
Returns
Type | Description |
---|---|
System.Boolean |
ValidacaoParametros(String, String, String, Int32, DateTime, BasBESerie)
Devolve True caso o documento a gravar passe nas validações dos parametros da série.
Pode validar por chave lógica, ou pelo objecto BasBESerie.
Declaration
bool ValidacaoParametros(string strModulo, string strDocumento, string strSerie, int lngNumDoc, DateTime datData, BasBESerie objSerie = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Identifica o modulo. |
System.String | strDocumento | Identifica o documento. |
System.String | strSerie | Identifica a série. |
System.Int32 | lngNumDoc | Identifica o numero do documento. |
System.DateTime | datData | Identifica a data do documento. |
BasBESerie | objSerie | Série a validar. |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaRemocao(String, String, String, ref String)
Permite efectuar a validação da série a remover
Declaration
bool ValidaRemocao(string strModulo, string strDocumento, string strSerie, ref string strErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence a série a remover. |
System.String | strDocumento | Documentoa que pertence a série a remover. |
System.String | strSerie | Série a remover. |
System.String | strErroValidacao | Devolve os erros encontrados durante a validação. |
Returns
Type | Description |
---|---|
System.Boolean |
ValidarSeriesDefeito(String, String, BasBESeries, ref String)
Validar todas as séries por defeito de um determinado documento
Declaration
bool ValidarSeriesDefeito(string strModulo, string strDocumento, BasBESeries objBeColl, ref string strErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
System.String | strModulo | Modulo a que pertence o documento. |
System.String | strDocumento | Documento ao qual as séries deverão estar associadas. |
BasBESeries | objBeColl | Lista de séries do documento. |
System.String | strErroValidacao | Devolve os erros encontrados durante a validação. |
Returns
Type | Description |
---|---|
System.Boolean |