PRIMAVERA | Developers

    Show / Hide Table of Contents

    Class StdBSExtensibilityConfiguration

    Service class to manage extensibility configuration.

    Inheritance
    System.Object
    StdBSExtensibilityConfiguration
    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
    public class StdBSExtensibilityConfiguration

    Constructors

    StdBSExtensibilityConfiguration()

    Declaration
    public StdBSExtensibilityConfiguration()

    Properties

    CommonExtensionsFolder

    Gets or sets the common extensions folder.

    Declaration
    public string CommonExtensionsFolder { get; }
    Property Value
    Type Description
    System.String

    Extensions

    Gets or sets the extensions.

    Declaration
    public List<Extension> Extensions { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<Primavera.Extensibility.BusinessEntities.Data.Extension>

    ExtensionsFolder

    Gets or sets the extensions folder.

    Declaration
    public string ExtensionsFolder { get; set; }
    Property Value
    Type Description
    System.String

    IntegrityCheckEnabled

    Validate extensions integrity

    Declaration
    public bool IntegrityCheckEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Actualiza(List<Extension>)

    Actualizas the specified object be.

    Declaration
    public void Actualiza(List<Extension> objExtensionList)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Primavera.Extensibility.BusinessEntities.Data.Extension> objExtensionList

    The object be.

    Exceptions
    Type Condition
    Primavera.Platform.Exceptions.ExpectedException

    _StdBSExtensibility.Actualiza

    ActualizaValorAtributo(String, String, Object)

    Actualizas the valor atributo.

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

    The string extension identifier.

    System.String strAtributo

    The string atributo.

    System.Object varValor

    The variable valor.

    ActualizaValorAtributos(String, StdBECampos)

    Actualizas the valor atributos.

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

    The string extension identifier.

    StdBECampos Atributos

    The atributos.

    Exceptions
    Type Condition
    Primavera.Platform.Exceptions.ExpectedException

    _BasBSArtigosClientes.ActualizaValorAtributosID

    BuildPexOnlyComponentsDetailMessage(IEnumerable<Type>)

    Builds the pex only components detail message.

    Declaration
    public string BuildPexOnlyComponentsDetailMessage(IEnumerable<Type> pexOnlyComponents)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.Type> pexOnlyComponents

    The pex only components.

    Returns
    Type Description
    System.String

    CloneExtensions(String, String)

    Adds the extensions.

    Declaration
    public void CloneExtensions(string strCompanyOrigin, string strCompanyDestiny)
    Parameters
    Type Name Description
    System.String strCompanyOrigin

    The string company origin.

    System.String strCompanyDestiny

    The string company destiny.

    CreateCommonExtensionPath()

    Creates the common extension path.

    Declaration
    public void CreateCommonExtensionPath()

    CreateCompanyExtensionPath(String)

    Creates the company extension path.

    Declaration
    public void CreateCompanyExtensionPath(string strCompany)
    Parameters
    Type Name Description
    System.String strCompany

    CreateExtensionPath(String)

    Creates the Extension Path.

    Declaration
    public string CreateExtensionPath(string extensionAssembly)
    Parameters
    Type Name Description
    System.String extensionAssembly
    Returns
    Type Description
    System.String

    DaValorAtributo(String, String)

    Das the valor atributo.

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

    The string extension identifier.

    System.String strAtributo

    The string atributo.

    Returns
    Type Description
    System.Object

    DaValorAtributos(String, Object[])

    Das the valor atributos.

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

    The string extension identifier.

    System.Object[] Atributos

    The atributos.

    Returns
    Type Description
    StdBECampos
    Exceptions
    Type Condition
    Primavera.Platform.Exceptions.ExpectedException

    _BasBSArtigosClientes.DaValorAtributos

    Edita(String)

    Editas the specified string extension identifier.

    Declaration
    public List<Extension> Edita(string strCompany = "")
    Parameters
    Type Name Description
    System.String strCompany

    The string extension identifier.

    Returns
    Type Description
    System.Collections.Generic.List<Primavera.Extensibility.BusinessEntities.Data.Extension>

    EditaTodos()

    Declaration
    public List<Extension> EditaTodos()
    Returns
    Type Description
    System.Collections.Generic.List<Primavera.Extensibility.BusinessEntities.Data.Extension>

    Existe(String)

    Existes the specified string extension identifier.

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

    The string extension identifier.

    Returns
    Type Description
    System.Boolean

    ExtensionFolder(String)

    Gets the extension folder.

    Declaration
    public string ExtensionFolder(string extensionAssembly)
    Parameters
    Type Name Description
    System.String extensionAssembly
    Returns
    Type Description
    System.String

    ExtensionsFolderByCompany(String)

    Extensionses the folder.

    Declaration
    public string ExtensionsFolderByCompany(string strCompany)
    Parameters
    Type Name Description
    System.String strCompany

    The string company.

    Returns
    Type Description
    System.String

    GetCompaniesList(Extension)

    Get list of companies associated to extension.

    Declaration
    public List<string> GetCompaniesList(Extension e)
    Parameters
    Type Name Description
    Primavera.Extensibility.BusinessEntities.Data.Extension e

    Extension

    Returns
    Type Description
    System.Collections.Generic.List<System.String>

    GetExtensionsForCompany(String, Boolean)

    Get all extensions for specified company.

    Declaration
    public List<Extension> GetExtensionsForCompany(string company, bool active)
    Parameters
    Type Name Description
    System.String company

    Company code

    System.Boolean active

    Active extensions

    Returns
    Type Description
    System.Collections.Generic.List<Primavera.Extensibility.BusinessEntities.Data.Extension>

    Inicializa(String)

    Inicializas the specified string company.

    Declaration
    public void Inicializa(string strCompany)
    Parameters
    Type Name Description
    System.String strCompany

    The string company.

    InsertExtensionFromFile(String, Boolean, String)

    Inserts the extension from file.

    Declaration
    public string InsertExtensionFromFile(string file, bool copyFile, string company = "")
    Parameters
    Type Name Description
    System.String file

    The extension file.

    System.Boolean copyFile

    Set true to copy file to final location.

    System.String company

    The company to associate. If not defined, it will be associated to all companies.

    Returns
    Type Description
    System.String

    The folder location for extension

    Remove(String)

    Removes the specified string extension identifier.

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

    The string extension identifier.

    Exceptions
    Type Condition
    Primavera.Platform.Exceptions.ExpectedException

    _StdBSExtensibility.Remove

    RemoveExtensions(String)

    Removes the extensions.

    Declaration
    public void RemoveExtensions(string strCompany)
    Parameters
    Type Name Description
    System.String strCompany

    The string company.

    SafeDeleteFile(String)

    Safes the delete file.

    Declaration
    public bool SafeDeleteFile(string file)
    Parameters
    Type Name Description
    System.String file

    The file.

    Returns
    Type Description
    System.Boolean

    SafeDeleteFolder(String)

    Deletes a folder without throwing errors.

    Declaration
    public bool SafeDeleteFolder(string folder)
    Parameters
    Type Name Description
    System.String folder
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(List<Extension>, ref String)

    Validas the actualizacao.

    Declaration
    public bool ValidaActualizacao(List<Extension> objExtensionList, ref string strErroValidacao)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Primavera.Extensibility.BusinessEntities.Data.Extension> objExtensionList

    The object extension list.

    System.String strErroValidacao

    The string erro validacao.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, ref String)

    Validas the remocao.

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

    The string extension identifier.

    System.String strErroValidacao

    The string erro validacao.

    Returns
    Type Description
    System.Boolean

    ValidateAddExtensions(String, String[])

    Validates the add extensions.

    Declaration
    public Dictionary<string, IEnumerable<Type>> ValidateAddExtensions(string strCompany, string[] fileNames)
    Parameters
    Type Name Description
    System.String strCompany
    System.String[] fileNames

    The file names.

    Returns
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.IEnumerable<System.Type>>