Table of Contents

Class VOStructure

Namespace
PHCDataLayer
Assembly
PHCDataLayer.dll
public class VOStructure : IVOStructure
Inheritance
VOStructure

Constructors

VOStructure()

protected VOStructure()

Remarks

Todos os construtores são protected. A utilização desta classe deve-se efectuar pelos métodos "Instances"

VOStructure(Type)

protected VOStructure(Type itemType)

Parameters

Nome Tipo Descrição
itemType Type

Fields

ImplementedInterfaces

public List<string> ImplementedInterfaces

Field Value

List<string>

lookStructures

protected static readonly object lookStructures

Field Value

object

Properties

AutoSelectableFields

public List<string> AutoSelectableFields { get; set; }

Property Value

List<string>

CanEditLoop

Is loop editing allowed for this entity?

public bool CanEditLoop { get; }

Property Value

bool

CollectionList

public IEnumerable<CollectionStruc> CollectionList { get; }

Property Value

IEnumerable<CollectionStruc>

CopyFromDefaultType

indica qual a regra que deverá de ser aplicada no momento da cópia dos registos da bd default para a instalação do cliente

public CopyFromDefaultDBTypeEnum CopyFromDefaultType { get; set; }

Property Value

CopyFromDefaultDBTypeEnum

Remarks

Um valor de Fast Copy indica que o registo é elimininado e criado do 0. Caso seja KeepUserFieldsA aplicação carrega os campos alterados pelo utilizador para esse registo, campos esses que estão definidos via campos alteraveis pelo utilizador.

DbFields

public List<FieldStructure> DbFields { get; }

Property Value

List<FieldStructure>

DocTypeMasterField

public FieldStructure DocTypeMasterField { get; set; }

Property Value

FieldStructure

EmailFieldForReport

public FieldStructure EmailFieldForReport { get; set; }

Property Value

FieldStructure

EntityDocType

public Type EntityDocType { get; set; }

Property Value

Type

EntityName

public string EntityName { get; set; }

Property Value

string

EntityType

public Type EntityType { get; }

Property Value

Type

EntityTypeField

public string EntityTypeField { get; set; }

Property Value

string

ExistPropertyParentVO

public bool ExistPropertyParentVO { get; set; }

Property Value

bool

ExtendedItemType

public Type ExtendedItemType { get; set; }

Property Value

Type

ExternalCollectionList

public IEnumerable<CollectionStruc> ExternalCollectionList { get; }

Property Value

IEnumerable<CollectionStruc>

FieldDocId

public FieldStructure FieldDocId { get; set; }

Property Value

FieldStructure

FieldPhcOwner

public FieldStructure FieldPhcOwner { get; set; }

Property Value

FieldStructure

FieldStamp

public FieldStructure FieldStamp { get; set; }

Property Value

FieldStructure

Fields

public List<FieldStructure> Fields { get; }

Property Value

List<FieldStructure>

FlagsCollection

public List<TableFlags> FlagsCollection { get; set; }

Property Value

List<TableFlags>

Gama

public Gamas Gama { get; set; }

Property Value

Gamas

GamaField

public FieldStructure GamaField { get; set; }

Property Value

FieldStructure

HasPermissionValidation

public bool HasPermissionValidation { get; set; }

Property Value

bool

Indexes

public List<IndexStruc> Indexes { get; set; }

Property Value

List<IndexStruc>

IsAttachable

public bool IsAttachable { get; set; }

Property Value

bool

IsExportable

public bool IsExportable { get; set; }

Property Value

bool

IsMasterEntity

public bool IsMasterEntity { get; }

Property Value

bool

IsSerializableToField

public bool IsSerializableToField { get; set; }

Property Value

bool

ItemType

public Type ItemType { get; set; }

Property Value

Type

JoinEntities

public JoinEntities JoinEntities { get; set; }

Property Value

JoinEntities

LabelFieldStruct

public FieldStructure LabelFieldStruct { get; set; }

Property Value

FieldStructure

LanguageField

public FieldStructure LanguageField { get; set; }

Property Value

FieldStructure

LogInfo

public List<string> LogInfo { get; set; }

Property Value

List<string>

MaintenanceClass

public Type MaintenanceClass { get; set; }

Property Value

Type

MaintenanceOrder

public int MaintenanceOrder { get; set; }

Property Value

int

MandatoryFields

public List<FieldStructure> MandatoryFields { get; }

Property Value

List<FieldStructure>

NameFieldForReport

public FieldStructure NameFieldForReport { get; set; }

Property Value

FieldStructure

NcontFieldForReport

public FieldStructure NcontFieldForReport { get; set; }

Property Value

FieldStructure

NotDuplicateFields

public List<FieldStructure> NotDuplicateFields { get; }

Property Value

List<FieldStructure>

OrderByFields

public List<OrderByItem> OrderByFields { get; set; }

Property Value

List<OrderByItem>

PermissionProfileField

public string PermissionProfileField { get; set; }

Property Value

string

PermissionTypeField

public string PermissionTypeField { get; set; }

Property Value

string

PermissionUserField

public string PermissionUserField { get; set; }

Property Value

string

PrimaryKey

public PrimaryKeyStruc PrimaryKey { get; set; }

Property Value

PrimaryKeyStruc

PrimaryKeys

public List<PrimaryKeyItem> PrimaryKeys { get; set; }

Property Value

List<PrimaryKeyItem>

RGPDIDList

public List<FieldStructure> RGPDIDList { get; set; }

Property Value

List<FieldStructure>

RGPDdata

public IRGDPdata RGPDdata { get; }

Property Value

IRGDPdata

RGPDrelevant

public bool RGPDrelevant { get; }

Property Value

bool

RelationShips

public List<RelationShip> RelationShips { get; set; }

Property Value

List<RelationShip>

RequiredProducts

public List<int> RequiredProducts { get; set; }

Property Value

List<int>

SerializableFields

public List<FieldStructure> SerializableFields { get; }

Property Value

List<FieldStructure>

SmartFields

public List<FieldStructure> SmartFields { get; }

Property Value

List<FieldStructure>

TableName

public string TableName { get; set; }

Property Value

string

TableRelease

public string TableRelease { get; set; }

Property Value

string

TableTarget

public DBTarget TableTarget { get; set; }

Property Value

DBTarget

UnprotectedFields

lista de campos que podem ser editados pelo utilizador mesmo que seja um registo interno da PHC (ex um campo "activo")

public List<string> UnprotectedFields { get; set; }

Property Value

List<string>

UpdatableFields

public List<FieldStructure> UpdatableFields { get; }

Property Value

List<FieldStructure>

UpdatableJsonFields

public List<FieldStructure> UpdatableJsonFields { get; }

Property Value

List<FieldStructure>

Methods

ClearAllStructure()

public static void ClearAllStructure()

ContainsField(string)

Not support alias or brackets, only "NOME" and not "FT.NOME" or "[FT].[NOME]" this method is StringComparer.OrdinalIgnoreCase

public bool ContainsField(string fieldName)

Parameters

Nome Tipo Descrição
fieldName string

Returns

bool

GetAttributeInfo<T>()

public T GetAttributeInfo<T>() where T : IGenericVOAttInfo

Returns

T

Type Parameters

T

GetCollection(string)

Support alias or brackets, "FIS" or "FT.FIS" or "[FT].[FIS]" or "FT.ADDONFIS2" this method is StringComparer.OrdinalIgnoreCase

public CollectionStruc GetCollection(string collectionName)

Parameters

Nome Tipo Descrição
collectionName string

Returns

CollectionStruc

GetCollectionByName(string)

public CollectionStruc GetCollectionByName(string name)

Parameters

Nome Tipo Descrição
name string

Returns

CollectionStruc

GetCollectionByTableName(string)

public CollectionStruc GetCollectionByTableName(string name)

Parameters

Nome Tipo Descrição
name string

Returns

CollectionStruc

GetField(OrderByItem)

public FieldStructure GetField(OrderByItem fieldItem)

Parameters

Nome Tipo Descrição
fieldItem OrderByItem

Returns

FieldStructure

GetField(string, VOStructure)

Support alias with or without brackets, this method is StringComparer.OrdinalIgnoreCase

NOME, FT.NOME, [NOME], [FT].[NOME] ADDON1.MORADA, FT.ADDON1.MORADA, [ADDON1].[MORADA], [FT].[ADDON1].[MORADA]

public FieldStructure GetField(string fieldName, VOStructure structureInstance = null)

Parameters

Nome Tipo Descrição
fieldName string
structureInstance VOStructure

Returns

FieldStructure

GetFieldStampName()

public string GetFieldStampName()

Returns

string

GetFieldsByFlag(FieldFlags)

public List<FieldStructure> GetFieldsByFlag(AttFieldType.FieldFlags flag)

Parameters

Nome Tipo Descrição
flag AttFieldType.FieldFlags

Returns

List<FieldStructure>

GetFieldsByInputType(InputTypes)

public List<FieldStructure> GetFieldsByInputType(AttFieldType.InputTypes inputType)

Parameters

Nome Tipo Descrição
inputType AttFieldType.InputTypes

Returns

List<FieldStructure>

GetLogInfoFields()

public List<FieldStructure> GetLogInfoFields()

Returns

List<FieldStructure>

GetRawCollection(string)

Not support alias or brackets, only "FIS" and not "FT.FIS" or "[FT].[FIS]" this method is StringComparer.OrdinalIgnoreCase

public CollectionStruc GetRawCollection(string collectionName)

Parameters

Nome Tipo Descrição
collectionName string

Returns

CollectionStruc

GetRawField(string, VOStructure)

Not support alias or brackets, only "NOME" and not "FT.NOME" or "[FT].[NOME]" this method is StringComparer.OrdinalIgnoreCase

public FieldStructure GetRawField(string fieldName, VOStructure structureInstance = null)

Parameters

Nome Tipo Descrição
fieldName string
structureInstance VOStructure

Returns

FieldStructure

GetStampValue(GenericVO)

public string GetStampValue(GenericVO item)

Parameters

Nome Tipo Descrição
item GenericVO

Returns

string

GetStructure(string)

public static VOStructure GetStructure(string entityName)

Parameters

Nome Tipo Descrição
entityName string

Returns

VOStructure

GetStructure(Type, bool)

public static VOStructure GetStructure(Type itemType, bool justGet = false)

Parameters

Nome Tipo Descrição
itemType Type
justGet bool

Returns

VOStructure

GetStructure<T>()

public static VOStructure GetStructure<T>() where T : GenericVO

Returns

VOStructure

Type Parameters

T

HasLocaleFields()

public bool HasLocaleFields()

Returns

bool

IsAllFieldsAvailable(params string[])

public bool IsAllFieldsAvailable(params string[] fieldsCollection)

Parameters

Nome Tipo Descrição
fieldsCollection string[]

Returns

bool

IsAnyFieldsAvailable(params string[])

public bool IsAnyFieldsAvailable(params string[] fieldsCollection)

Parameters

Nome Tipo Descrição
fieldsCollection string[]

Returns

bool

SetStampValue(GenericVO, string)

public void SetStampValue(GenericVO item, string stampID)

Parameters

Nome Tipo Descrição
item GenericVO
stampID string

Explicit Interface Implementations

IsSameEntity(string)

bool IsSameEntity(string valueName)

Parameters

Nome Tipo Descrição
valueName string

Returns

bool