Table of Contents

Class MapEntityVO

Namespace
PHCBusinessLayer
Assembly
PHCBusinessLayer.dll
[AttTable("MapEntity", 20240510)]
[AttTableProducts(new Products[] { Products.Accounting })]
[AttTableVOInfo(typeof(MapEntityAttInfo))]
[AttTableTarget(DBTarget.Home)]
[AttTableFlags(new TableFlags[] { TableFlags.MasterEntity, TableFlags.FullTextSearchable, TableFlags.TableForJorge, TableFlags.AddOnNotCustomizable, TableFlags.AddOnFramework, TableFlags.StudioOnly })]
[AttTableMaintenance(typeof(MapEntityMaintenance))]
public class MapEntityVO : BusinessVO, IBaseSerialization, ICloneVO, ICloneable, IChange, IParent, IGenericVO
Inheritance
MapEntityVO

Properties

GetFieldStampName

Use only field name without table name

public override string GetFieldStampName { get; }

Property Value

string

GetStampValue

public override string GetStampValue { get; }

Property Value

string

actions

[AttCollection(typeof(MainFormActionVO), new string[] { "[MainFormAction].[parentStamp]", "[MapEntity].[mapEntitystamp]" })]
public List<MainFormActionVO> actions { get; set; }

Property Value

List<MainFormActionVO>

allowManualCtb

Allow manual year

[AttFieldType(AttFieldType.InputTypes.boolean)]
public bool allowManualCtb { get; set; }

Property Value

bool

allowQuarterly

Allow qarterly period map

[AttFieldType(AttFieldType.InputTypes.boolean)]
public bool allowQuarterly { get; set; }

Property Value

bool

allowbudget

Allow Budgets

[AttFieldType(AttFieldType.InputTypes.boolean)]
[AttGama(Gamas.Enterprise)]
public bool allowbudget { get; set; }

Property Value

bool

allowdimshrchy

Allow Dimensions and Hierarchy

[AttFieldType(AttFieldType.InputTypes.boolean)]
[AttGama(Gamas.Advanced)]
public bool allowdimshrchy { get; set; }

Property Value

bool

calculationPeriod

Allow qarterly period map

[AttFieldType(AttFieldType.InputTypes.integer)]
public MapEntityBiz.CalculationPeriod calculationPeriod { get; set; }

Property Value

MapEntityBiz.CalculationPeriod

category

Group

[AttLenght(30)]
[AttMandatory]
public string category { get; set; }

Property Value

string

civilperiods

[AttFieldType(AttFieldType.InputTypes.boolean)]
public bool civilperiods { get; set; }

Property Value

bool

description

Description given by developer

[AttList]
public string description { get; set; }

Property Value

string

edition

Minimum plan to set map entity available

[AttLenght(2)]
public Gamas edition { get; set; }

Property Value

Gamas

entity

calculated from "name" it will be EntityCustomization table name

[AttLenght(100)]
[AttLogInfo(1)]
[AttFieldType(AttFieldType.InputTypes.string, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public string entity { get; set; }

Property Value

string

hiddenObjects

[AttCollection(typeof(MainFormObjectVO), new string[] { "[MainFormObject].[parentStamp]", "[MapEntity].[mapEntitystamp]" })]
public List<MainFormObjectVO> hiddenObjects { get; set; }

Property Value

List<MainFormObjectVO>

mainObjects

[AttCollection(typeof(MainFormObjectVO), new string[] { "[MainFormObject].[parentStamp]", "[MapEntity].[mapEntitystamp]" })]
public List<MainFormObjectVO> mainObjects { get; set; }

Property Value

List<MainFormObjectVO>

mapEntitystamp

ID, used to link others to this entity.

[AttLenght(25)]
public string mapEntitystamp { get; set; }

Property Value

string

Remarks

This field uniquely identifies the record.

name

Name of screen map (will generate table name)

[AttLenght(60)]
[AttMandatory]
[AttLogInfo(0)]
[AttList]
public string name { get; set; }

Property Value

string

recordDesignation

Multilang

[AttLenght(250)]
public string recordDesignation { get; set; }

Property Value

string

rulecode

Code to run onSync this map mostly for totalizers base on grids

[AttFieldType(AttFieldType.InputTypes.memo)]
[AttList(Hidden = true)]
public string rulecode { get; set; }

Property Value

string

tabs

[AttCollection(typeof(MainFormTabVO), new string[] { "[MainFormTab].[mapEntitystamp]", "[MapEntity].[mapEntitystamp]" })]
public List<MainFormTabVO> tabs { get; set; }

Property Value

List<MainFormTabVO>

title

Title given by developer

[AttLenght(100)]
public string title { get; set; }

Property Value

string

toolDescription

Virtual use only for "recent" tab @frontend Do not forget to include AttList for fields that are included in virtual

[AttVirtualField]
public string toolDescription { get; set; }

Property Value

string

toolName

Virtual use only for "recent" tab @frontend Do not forget to include AttList for fields that are included in virtual

[AttVirtualField]
public string toolName { get; set; }

Property Value

string

translations

[AttCollection(typeof(UserLocaleVO), new string[] { "[UserLocale].[parentStamp]", "[MapEntity].[mapEntitystamp]" })]
public List<UserLocaleVO> translations { get; set; }

Property Value

List<UserLocaleVO>

updateConfigCode

Code Typescript to run on mainform updateConfig fn

public string updateConfigCode { get; set; }

Property Value

string

updateConfigCodeEncrypted

[AttVirtualField]
public string updateConfigCodeEncrypted { get; set; }

Property Value

string

usedimensions

[AttVirtualField]
[AttHidden]
public bool usedimensions { get; set; }

Property Value

bool

Methods

AsEntityCustomizations()

Get the proper representation of this in EntityCustomization Purpose: Addon Installation

public List<EntityCustomizationVO> AsEntityCustomizations()

Returns

List<EntityCustomizationVO>

GetAllGridFormulas()

public List<MainFormObjectVO> GetAllGridFormulas()

Returns

List<MainFormObjectVO>

GetAllMainFormAutocompletes()

Utility function to install DataProviders on addon DLL

public List<MainFormFieldVO> GetAllMainFormAutocompletes()

Returns

List<MainFormFieldVO>

GetAllMainFormFields()

List of flaten fields: MainFormFieldVO Just for sql structure validations

public List<MainFormFieldVO> GetAllMainFormFields()

Returns

List<MainFormFieldVO>

GetAllMainFormTablesAndGrids()

Utility function to install DataProviders on addon DLL Tabels and GRIDs with search popup

public List<MainFormObjectVO> GetAllMainFormTablesAndGrids()

Returns

List<MainFormObjectVO>

GetAllRelatedFormulas()

public List<FormulaVO> GetAllRelatedFormulas()

Returns

List<FormulaVO>

GetMainFormObjectsByType(MainFormObjectType)

public List<MainFormObjectVO> GetMainFormObjectsByType(MainFormObjectType type)

Parameters

Nome Tipo Descrição
type MainFormObjectType

Returns

List<MainFormObjectVO>

LoadAllCollections()

Desperate times requires desperate measures...

public override void LoadAllCollections()

SetStampValue(string)

public override void SetStampValue(string stampID)

Parameters

Nome Tipo Descrição
stampID string

Explicit Interface Implementations

AsStudioTool()

StudioToolVO AsStudioTool()

Returns

StudioToolVO

CanDeleteTool()

bool CanDeleteTool()

Returns

bool

ToolMainFields()

List<string> ToolMainFields()

Returns

List<string>