IPropertyDefinition Interface

Interface for defining a single PropertyDefinition, many of these will be associated with an IObjectDefinition

Namespace:  Scribe.Core.ConnectorApi.Metadata

Assembly:  Scribe.Core.ConnectorApi (in Scribe.Core.ConnectorApi.dll)

Syntax

public   interface   IPropertyDefinition

The IPropertyDefinition type exposes the following members.

Properties

 

Name

Description

Public property

Description

Gets or sets Description. Properties are set to convey any of the following additional helpful information about the field: 1. If the field will be defaulted and if possible the value it will be defaulted to. 2. The property’s application specific “native” data type (if application does not natively use .NET system types) 3. Any ranges or restrictions placed of the field 4. Possible or required pick list values

Public property

FullName

Gets or sets FullName. This must be a unique value and will be used to reference this property. Must not contain any non-alphanumeric characters other than the underscore.

Public property

IsPrimaryKey

This property will get/set a flag on whether this property is part of (or is) the primary key.

Public property

MaxOccurs

Gets or sets MaxOccurs.

Public property

MinOccurs

Gets or sets MinOccurs.

Public property

Name

Gets or sets Name.

Public property

Nullable

Gets or sets a value indicating whether Nullable. Properties are true only if the property can be set to NULL. Some fields are NOT Nullable but are also defaulted on insert. For this reason the Nullable property does not indicate if the field is required, it only indicates that a user will likely receive an error if they attempt to set a NULL value into the field on update. NOTE: This field is purely informational. It dictates no behavior in the application.

Public property

NumericPrecision

Holds property/field precision for numeric data types

Public property

NumericScale

Holds property/field scale for numeric data types

Public property

PresentationType

Gets or sets PresentationType.

Public property

PropertyType

Holds property/field data type These should be .NET system data types that the core can use e.g. system.int32, system.string

Public property

RequiredInActionInput

This property will get/set a flag on whether this property is required in action inputs. Properties are true only if a value must be provided for this field for any of the Actions that can be performed on this properties object. RequiredInActionInput should be false for a field such as an ID field that is listed as “required” or NOT Nullable by the Connectors API, but is yet somehow defaulted on insert. NOTE: This field will drive the display of required fields in the UI.

Public property

Size

Gets or sets Size.

Public property

UsedInActionInput

This property will get/set a flag on whether this property is used in action inputs. Properties are true only if a value can be provided for this field for any of the Actions that can be performed on this properties object. NOTE: This field will drive the display of read only fields in the UI.

Public property

UsedInActionOutput

This property will get/set a flag on whether this property is used in action outputs.

Public property

UsedInLookupCondition

This property will get/set a flag on whether this property is used in lookup conditions. Properties are true only if a value can be provided for this field in the LookupCondition for any of the Actions that can be performed on this properties object. NOTE: This field should be used to only filter the list of possible Match Code fields in the UI

Public property

UsedInQueryConstraint

This property will get/set a flag on whether this property is used in query constraints. Properties are true only if a value can be used in the query’s constraint expression. NOTE: This field will be used to filter the list of source fields available for use as filters

Public property

UsedInQuerySelect

This property will get/set a flag on whether this property is used in query selects. Properties are true only if a value can be returned in the results of a query. NOTE: This field will be used to filter the list of source fields in the Formula editor and mapper UI

Public property

UsedInQuerySequence

This property will get/set a flag on whether this property is used in query sequences.

See

Scribe.Core.ConnectorApi.Metadata Namespace