• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Class AstContainerTaskBaseNode

AstContainerTaskBaseNode is the base type that is used for all SQL Server Integration Services task containers in Biml.

Namespace:
Varigence.Languages.Biml.Task
Assembly:
Biml.dll
C#
    [AstDoNotEmitXmlSchemaType]
public abstract class AstContainerTaskBaseNode : AstTaskNode, IBindableItem, IVulcanCollectionParent, IVulcanNotifyPropertyChanged, IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, INotifyPropertyChanged, IXObjectMappingProvider, IValidationInfo, IDataErrorInfo, INamedItem, IScopedNameIndexable, IDataflowItem
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstScopeBoundaryNode
AstTaskNode
AstContainerTaskBaseNode
Derived
AstContainerTaskBaseNode
AstContainerTaskNode
AstTaskEventHandlerNode
Implements

IBindableItem, Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, IValidationInfo, System.ComponentModel.IDataErrorInfo, INamedItem, Varigence.Utility.Collections.IScopedNameIndexable, IDataflowItem,

Constructors

AstContainerTaskBaseNode(IFrameworkItem)

Initializes a new instance of the AstContainerTaskBaseNode class with the specified parent node.

Properties

ConstraintMode

This value specifies the mode that should be used to execute the children of the container or package. Parallel directly matches the SSIS behavior and will require that precedence constraints are created manually for all task connections. Linear will automatically create precedence constraints so that tasks will run one after the other in the order that they are specified in the Biml. Linear is primarily useful for scripting scenarios where creating precedence constraints would be tedious.

ConstraintModeDefaultValue

Gets the default value for the ConstraintMode property

ContainerTasks

Gets a collection of all child tasks of this container that are themselves either container tasks or dataflow tasks

FriendlyTypeName

Gets the friendly name of the type of this node

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

SsisAnnotations

This is a collection of SSIS annotations that will be rendered on the SSIS design surface within the parent container object.

StaticUserDefinedItems

Specifies a collection of items that are common across all instances of the same type in the framework.

Tasks

Container for child task definitions.

Methods

BindingScopeBoundaries()

Retrieves the permitted scope boundaries to bind references from this node.

CanDropItemOfType(Type)

Gets a value to indicate whether items of the specified type can be dropped onto this item in the design surface

ConvertToParallelConstraintMode()

Converts all implicit precedence constraints in this package into explicit precedence constraints. This is only relevant for containers with a constraint mode of linear.

ConvertToParallelConstraintMode(AstTaskNode)

Converts all implicit precedence constraints in this package into explicit precedence constraints. This is only relevant for containers with a constraint mode of linear. No precedence constraint will be created with sinkTaskToIgnore as a sink (endpoint).

CopyFrom(IFrameworkItem, UnboundReferences)

Instructs the node to copy property values from the supplied node into itself. This method should only be used by the internal Biml framework.

DefinedAstNodes()

Retrieves a collection of nodes that have been defined as direct children of the current node.

Duplicate()

Creates a duplicate of the current node

Duplicate(Dictionary<IFrameworkItem, IFrameworkItem>)

Creates a duplicate of the current node with the scoped node mapping

Duplicate(IFrameworkItem)

Creates a duplicate of the current node with the specified parent item

Duplicate(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>)

Creates a duplicate of the current node with the specified parent item and scoped node mapping

DuplicateHusk(IFrameworkItem)

Creates an empty object into which the values from the current node will be duplicated. This method should only be used by the internal Biml framework

DuplicateInto(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>)

Copies the values from the current node into a husk object with the specified scoped node mapping. This method should only be used by the internal Biml framework

EmitXmlForAction(AstEnginePropertyAction)

Instructs the node to make changes to its underlying Biml code that correspond to the provided action. This method should only be used by the internal Biml framework.

EmitXmlForProperty(String, Int32)

Instructs the node to make changes to its underlying Biml code that correspond to the provided property and index. This method should only be used by the internal Biml framework.

GetAllItemsReferencedByDefinedSuccessors()

Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem.

GetBimlAttributeFragment(CulturedStringBuilder)
GetBimlChildFragment(CulturedStringBuilder, Int32)
GetBimlFragment(CulturedStringBuilder, Int32, Boolean)

Internal method used by the Biml engine to produce the XML code for the current object.

GetDefaultValue(String)

Retrieves the default value for the property with the name propertyName

GetDefaultValue<T>(String)

Retrieves the default value for the property with the name propertyName

GetJson(StringBuilder, ref Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)

Generates a JavaScript Object Notation (JSON) representation of the current node

GetPotentialParentProperties()

Retrieves the reflection information for related properties of this node type.

GetPropertyValue(String)

Retrieves the current value for the property with the name propertyName

GetReflectionInfoFromXmlParsePath(String)

Retrieves the reflection information corresponding to the Xml parse path beginning at this node.

HasAnyBimlChildNodes()
MergeFrom(IFrameworkItem, UnboundReferences, Boolean)

Instructs the node to merge property values from the supplied node into itself. This method should only be used by the internal Biml framework.

NotifyCollectionPropertyChanged(Object, String, NotifyCollectionChangedEventArgs)

Internal Biml framework method used to notify this node that the specified collection property value has changed.

ParseAttribute(XAttribute, ParserContext)
ParseChild(XElement, ParserContext)
StructureEquals(Object)

Compares this node to the provided object to determine if all defined children and references are equal.

TransformerNotifyLocalMerged(String, Boolean, Boolean)

This method is called by the Biml Framework to indicate when a BimlScript transformer merge has been completed. This permits the node to automatically create paths once the merge is complete.

TransformerNotifyLocalMerging(Boolean, Boolean)

This method is called by the Biml Framework to indicate when a BimlScript transformer merge is about to take place. This permits the node to store information necessary to automatically create paths once the merge is complete.

© Varigence