PRIMAVERA | Developers

    Show / Hide Table of Contents

    Class StdBSIDU

    Classe utilizada para obter serviços e regras de negócio sobre os Indicadores do Utilizador.

    Inheritance
    System.Object
    StdBSIDU
    Implements
    IStdBSIDU
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: StdPlatBS100
    Assembly: StdPlatBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("626C8222-3427-4E57-8F64-BE488D62A961")]
    [ClassInterface(ClassInterfaceType.None)]
    public class StdBSIDU : IStdBSIDU

    Methods

    Actualiza(StdBEIDU)

    Declaration
    public void Actualiza(StdBEIDU objIndicador)
    Parameters
    Type Name Description
    StdBEIDU objIndicador

    Actualiza(StdBEIDU, ref String)

    Actualiza indicador.

    Declaration
    public void Actualiza(StdBEIDU objIndicador, ref string strAvisos)
    Parameters
    Type Name Description
    StdBEIDU objIndicador

    Definição do indicador do utilizador.

    System.String strAvisos

    Mensagem com os avisos reportados pela actualização.

    ActualizaLog(StdBEIDULog)

    Declaration
    public void ActualizaLog(StdBEIDULog objLog)
    Parameters
    Type Name Description
    StdBEIDULog objLog

    ActualizaLog(StdBEIDULog, ref String)

    Actualiza Log.

    Declaration
    public void ActualizaLog(StdBEIDULog objLog, ref string strAvisos)
    Parameters
    Type Name Description
    StdBEIDULog objLog
    System.String strAvisos

    Mensagem com os avisos reportados pela actualização.

    ActualizaNoMonitorNegocios(String, ref String, Boolean)

    Actualiza a visibilidade de um indicador no monitor de negócios.

    Declaration
    public void ActualizaNoMonitorNegocios(string strIdIndicador, ref string strUtilizador, bool blnMonitorNegocios)
    Parameters
    Type Name Description
    System.String strIdIndicador

    Identificador do indicador.

    System.String strUtilizador

    Nome do utilizador.

    System.Boolean blnMonitorNegocios

    Visibilidade.

    ActualizaResultado(StdBEIDUResultado)

    Declaration
    public void ActualizaResultado(StdBEIDUResultado objResultado)
    Parameters
    Type Name Description
    StdBEIDUResultado objResultado

    ActualizaResultado(StdBEIDUResultado, ref String)

    Actualiza resultados.

    Declaration
    public void ActualizaResultado(StdBEIDUResultado objResultado, ref string strAvisos)
    Parameters
    Type Name Description
    StdBEIDUResultado objResultado

    Definição do resultado.

    System.String strAvisos

    Erros da actualização.

    ActualizaValorAtributo(String, String, Boolean)

    Actualiza o valor do atributo.

    Declaration
    public void ActualizaValorAtributo(string strId, string strAtributo, bool vntValor)
    Parameters
    Type Name Description
    System.String strId

    Id.

    System.String strAtributo

    Atributo.

    System.Boolean vntValor

    Valor.

    ActualizaValorAtributoResultado(String, String, Object)

    Actualiza o valor do atributo resultado.

    Declaration
    public void ActualizaValorAtributoResultado(string strId, string strAtributo, object vntValor)
    Parameters
    Type Name Description
    System.String strId

    Id.

    System.String strAtributo

    Atributo.

    System.Object vntValor

    Valor.

    ActualizaValorAtributos(String, StdBECampos)

    Actualiza o valor de um conjunto de atributos.

    Declaration
    public void ActualizaValorAtributos(string strId, StdBECampos objAtributos)
    Parameters
    Type Name Description
    System.String strId

    Identificador do indicador do utilizador.

    StdBECampos objAtributos

    Valores a actualizar.

    CancelaExecucao()

    Cancela a execução.

    Declaration
    public void CancelaExecucao()

    DaInfoExecucoes(String, ref Int32, ref Int32, ref Int32, ref Int32)

    Devolve os parâmetros com os dados relativos á execução dos indicadores

    Declaration
    public void DaInfoExecucoes(string strIdIndicador, ref int intTotalExec, ref int intExecSucesso, ref int intExecManuais, ref int intTempoMedioExec)
    Parameters
    Type Name Description
    System.String strIdIndicador

    Id do indicador.

    System.Int32 intTotalExec

    Total de Execuções do Indicador de Utilizador

    System.Int32 intExecSucesso

    Total de execuções com Sucesso do Indicador de Utilizador

    System.Int32 intExecManuais

    Total de execuções Manuais

    System.Int32 intTempoMedioExec

    Tempo Médio de Execução do Indicador de Utilizador (ms)

    DaListaRegistosIndicador(StdBEIDU, StdBEIDUUtilizador, DateTime, DateTime)

    Devolve a lista de registos do indicador.

    Declaration
    public StdBELista DaListaRegistosIndicador(StdBEIDU objIndicador, StdBEIDUUtilizador objUtilizador, DateTime datDataReferencia, DateTime datDataExecucao)
    Parameters
    Type Name Description
    StdBEIDU objIndicador

    Definição do Indicador.

    StdBEIDUUtilizador objUtilizador

    Definição do utilizador.

    System.DateTime datDataReferencia

    Data de referência.

    System.DateTime datDataExecucao

    Data de execução.

    Returns
    Type Description
    StdBELista

    DaNumeroResultados(String)

    Devolve o número de resultados por utilizador.

    Declaration
    public int DaNumeroResultados(string strUtilizador)
    Parameters
    Type Name Description
    System.String strUtilizador

    Nome do utilizador.

    Returns
    Type Description
    System.Int32

    DaResultadoMaisRecenteIndicador(String, String)

    Devolve o resultado mais recente do indicador.

    Declaration
    public StdBEIDUResultado DaResultadoMaisRecenteIndicador(string strUtilizador, string strIdIndicador)
    Parameters
    Type Name Description
    System.String strUtilizador

    Nome do utilizador.

    System.String strIdIndicador

    Identificador do indicador.

    Returns
    Type Description
    StdBEIDUResultado

    DaResultadosMaisRecentesIndicadoresCategoria(String, String)

    Devolve os resultados mais recentes por utilizador e categoria.

    Declaration
    public StdBEIDUResultados DaResultadosMaisRecentesIndicadoresCategoria(string strUtilizador, string strCategoria)
    Parameters
    Type Name Description
    System.String strUtilizador

    Nome do utilizador.

    System.String strCategoria

    Categoria do indicador.

    Returns
    Type Description
    StdBEIDUResultados

    DaValorAtributo(String, String)

    Devolve o valor de um atributo.

    Declaration
    public string DaValorAtributo(string strId, string strAtributo)
    Parameters
    Type Name Description
    System.String strId

    Identificador do indicador do utilizador.

    System.String strAtributo

    Nome do atributo.

    Returns
    Type Description
    System.String

    DaValorAtributos(String, Object[])

    Devolve os valores de Atributos.

    Declaration
    public StdBECampos DaValorAtributos(string strId, params object[] vntAtributos)
    Parameters
    Type Name Description
    System.String strId

    Identificador do indicador do utilizador.

    System.Object[] vntAtributos

    Nomes dos atributos.

    Returns
    Type Description
    StdBECampos

    Edita(String)

    Devolve um indicador.

    Declaration
    public StdBEIDU Edita(string strId)
    Parameters
    Type Name Description
    System.String strId

    Identificador do indicador do utilizador.

    Returns
    Type Description
    StdBEIDU

    EditaResultado(String)

    Devolve um resultado de um indicador.

    Declaration
    public StdBEIDUResultado EditaResultado(string strIdResultado)
    Parameters
    Type Name Description
    System.String strIdResultado

    Identificador do resultado.

    Returns
    Type Description
    StdBEIDUResultado

    Executa(String)

    Executa indicador.

    Declaration
    public bool Executa(string strId)
    Parameters
    Type Name Description
    System.String strId

    Identificador do indicador do utilizador.

    Returns
    Type Description
    System.Boolean

    ExecutaIndicador(StdBEIDU)

    Executa indicador

    Declaration
    public bool ExecutaIndicador(StdBEIDU objIndicador)
    Parameters
    Type Name Description
    StdBEIDU objIndicador

    Indicador do Utilizador (StdBEIDU)

    Returns
    Type Description
    System.Boolean

    Existe(String)

    Verifica se existe um indicador.

    Declaration
    public bool Existe(string strId)
    Parameters
    Type Name Description
    System.String strId

    Identificador do indicador do utilizador.

    Returns
    Type Description
    System.Boolean

    ExisteErrosExecucao(String, DateTime, String)

    Indica se numa dada Execução de um Indicador do Utilizador existiram erros de execução.

    Declaration
    public bool ExisteErrosExecucao(string strIdIndicador, DateTime dtDataExecucao, string strUtilizador)
    Parameters
    Type Name Description
    System.String strIdIndicador

    Id do Indicador do Utilizador.

    System.DateTime dtDataExecucao

    Data de Execução do Indicador.

    System.String strUtilizador

    Utilizador.

    Returns
    Type Description
    System.Boolean

    ExisteIndicador(String)

    Valida se já existe um Indicador do Utilizador com o mesmo nome.

    Declaration
    public bool ExisteIndicador(string strNome)
    Parameters
    Type Name Description
    System.String strNome

    Nome do indicador.

    Returns
    Type Description
    System.Boolean

    ExisteResultadosExecucao(String, DateTime, String)

    Indica se uma dada Execução de um Indicador do Utilizador devolveu Resultados.

    Declaration
    public bool ExisteResultadosExecucao(string strIdIndicador, DateTime dtDataExecucao, string strUtilizador)
    Parameters
    Type Name Description
    System.String strIdIndicador

    Id do Indicador do Utilizador.

    System.DateTime dtDataExecucao

    Data de Execução do Indicador.

    System.String strUtilizador

    Utilizador.

    Returns
    Type Description
    System.Boolean

    Finalize()

    Declaration
    protected void Finalize()

    LimpaHistoricoExecucoes(String, ref String)

    Remove o registo de execuções do Indicador do Utilizador.

    Declaration
    public void LimpaHistoricoExecucoes(string strIdIndicador, ref string strUtilizador)
    Parameters
    Type Name Description
    System.String strIdIndicador

    Identificador do Id do Indicador do Utilizador a remover.

    System.String strUtilizador

    Utilizador do qual os registos devem ser removidos.

    Lista(Boolean, String)

    Lista de indicadores.

    Declaration
    public StdBEIDUs Lista(bool blnApenasSistema, string strUtilizador = "")
    Parameters
    Type Name Description
    System.Boolean blnApenasSistema

    Indica se o método devolve apenas os indicadores de sistema.

    System.String strUtilizador

    Nome do utilizador.

    Returns
    Type Description
    StdBEIDUs

    ListaCategoriasResultados(String)

    Devolve uma lista com as categorias dos resultados.

    Declaration
    public string[] ListaCategoriasResultados(string strUtilizador)
    Parameters
    Type Name Description
    System.String strUtilizador

    Nome do utilizador.

    Returns
    Type Description
    System.String[]

    ListaCategoriasResultadosTodos()

    Devolve uma lista com todas as categorias dos resultados.

    Declaration
    public string[] ListaCategoriasResultadosTodos()
    Returns
    Type Description
    System.String[]

    ListaIndicadoresExecutar()

    Devolve uma lista com os indicadores a executar.

    Declaration
    public StdBELista ListaIndicadoresExecutar()
    Returns
    Type Description
    StdBELista

    ListaLogs(String)

    Devolve uma lista de Log's

    Declaration
    public StdBEIDULogs ListaLogs(string strIdIndicador)
    Parameters
    Type Name Description
    System.String strIdIndicador

    Identificador do indicador do utilizador.

    Returns
    Type Description
    StdBEIDULogs

    ListaLogsUtilizador(String, String)

    Devolve uma lista de Log's

    Declaration
    public StdBEIDULogs ListaLogsUtilizador(string strIdIndicador, string strUtilizador = "")
    Parameters
    Type Name Description
    System.String strIdIndicador

    Identificador do indicador do utilizador.

    System.String strUtilizador

    Nome do utilizador.

    Returns
    Type Description
    StdBEIDULogs

    ListaResultados(String, Boolean, Int32, StdBETipos.EnumIdentificadoresTempo)

    Devolve uma lista com os resultados dos indicadores.

    Declaration
    public StdBEIDUResultados ListaResultados(string strUtilizador, bool blnLimitaResultados, int lngLimiteResultados, StdBETipos.EnumIdentificadoresTempo enuTipoLimiteResultados)
    Parameters
    Type Name Description
    System.String strUtilizador

    Nome do utilizador.

    System.Boolean blnLimitaResultados

    Limita os resultados.

    System.Int32 lngLimiteResultados

    Valor do limite do resultado.

    StdBETipos.EnumIdentificadoresTempo enuTipoLimiteResultados

    Tipo de limite de resultados.

    Returns
    Type Description
    StdBEIDUResultados

    ListaTags()

    Devolve uma Lista de Indicadores do Utilizador.

    Declaration
    public StdBETipos.Tag[] ListaTags()
    Returns
    Type Description
    StdBETipos.Tag[]

    NoMonitorNegociosUtilizador(String, String)

    Indica se o Indicador do Utilizador está visível no Mon. de Negócios do utilizador.

    Declaration
    public bool NoMonitorNegociosUtilizador(string strUtilizador, string strIdIndicador)
    Parameters
    Type Name Description
    System.String strUtilizador

    Nome do utilizador.

    System.String strIdIndicador

    Identificador do indicador.

    Returns
    Type Description
    System.Boolean

    NumeroIndicadoresExecutar()

    Devolve o número de indicadores a executar.

    Declaration
    public int NumeroIndicadoresExecutar()
    Returns
    Type Description
    System.Int32

    RefrescaResultado(StdBEIDUResultado)

    Refresca resultado.

    Declaration
    public bool RefrescaResultado(StdBEIDUResultado objResultado)
    Parameters
    Type Name Description
    StdBEIDUResultado objResultado

    Definição do resultado.

    Returns
    Type Description
    System.Boolean

    RegistaLimpezaLog(StdBEIDU)

    Regista a acção de Limpeza de Log.

    Declaration
    public void RegistaLimpezaLog(StdBEIDU objIndicador)
    Parameters
    Type Name Description
    StdBEIDU objIndicador

    Indicador.

    Remove(String)

    Remove.

    Declaration
    public void Remove(string strId)
    Parameters
    Type Name Description
    System.String strId

    RemoveLog(String)

    Remove Log.

    Declaration
    public void RemoveLog(string strIdLog)
    Parameters
    Type Name Description
    System.String strIdLog

    Identificador do indicadores do utilizador.

    RemoveResultados(StdBEValoresStr)

    Remove resultados.

    Declaration
    public void RemoveResultados(StdBEValoresStr objIds)
    Parameters
    Type Name Description
    StdBEValoresStr objIds

    Identificadores dos indicadores do utilizador.

    ValidaActualizacao(StdBEIDU, ref String)

    Valida a actualização de um indicador.

    Declaration
    public bool ValidaActualizacao(StdBEIDU objIndicador, ref string strErros)
    Parameters
    Type Name Description
    StdBEIDU objIndicador

    Definição do indicador do utilizador.

    System.String strErros

    Mensagem com os erros de validação.

    Returns
    Type Description
    System.Boolean

    ValidaActualizacaoLog(StdBEIDULog, ref String)

    Valida a actualização de um log de um indicador.

    Declaration
    public bool ValidaActualizacaoLog(StdBEIDULog objLog, ref string strErros)
    Parameters
    Type Name Description
    StdBEIDULog objLog
    System.String strErros

    Mensagem com os erros de validação.

    Returns
    Type Description
    System.Boolean

    ValidaActualizacaoResultado(StdBEIDUResultado, ref String)

    Valida a actualização de resultados de um indicador.

    Declaration
    public bool ValidaActualizacaoResultado(StdBEIDUResultado objResultado, ref string strErros)
    Parameters
    Type Name Description
    StdBEIDUResultado objResultado

    Definição do resultado.

    System.String strErros

    Mensagem com os erros de validação.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, ref String)

    Valida a remoção de um indicador.

    Declaration
    public bool ValidaRemocao(string strId, ref string strErros)
    Parameters
    Type Name Description
    System.String strId
    System.String strErros
    Returns
    Type Description
    System.Boolean

    ValidaRemocaoLog(String, ref String)

    Valida a remoção de um Log.

    Declaration
    public bool ValidaRemocaoLog(string strIdLog, ref string strErros)
    Parameters
    Type Name Description
    System.String strIdLog

    Identificador do log.

    System.String strErros

    Mensagem com os erros de validação.

    Returns
    Type Description
    System.Boolean

    ValidaRemocaoResultados(StdBEValoresStr, ref String)

    Valida a remoção de resultados.

    Declaration
    public bool ValidaRemocaoResultados(StdBEValoresStr objIds, ref string strErros)
    Parameters
    Type Name Description
    StdBEValoresStr objIds

    Identificadores dos resultados.

    System.String strErros

    Mensagem com os erros de validação.

    Returns
    Type Description
    System.Boolean

    Implements

    IStdBSIDU