Class RecordRelationship
Represents a one-to-one relationship between LogicalRecords.
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class RecordRelationship : IdentifiableBase, IIdentifiable, IDescribable, IVisitableConstructors
RecordRelationship()
Initializes a new instance of the RecordRelationship class.
Declaration
public RecordRelationship()Properties
Description
Gets a description of the relationship.
Declaration
public virtual MultilingualString Description { get; }Property Value
| Type | Description |
|---|---|
| MultilingualString |
Implements
DisplayLabel
Gets the display label.
Declaration
public string DisplayLabel { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
The display label returns text to be displayed in a user interface or in generated documentation.
ItemName
Gets the name of the item.
Declaration
public virtual MultilingualString ItemName { get; }Property Value
| Type | Description |
|---|---|
| MultilingualString | The name of the item. |
Implements
Label
Gets the label for the relationship.
Declaration
public MultilingualString Label { get; }Property Value
| Type | Description |
|---|---|
| MultilingualString |
Implements
RelationshipType
Gets or sets the type of the relationship between the items.
Declaration
public RecordRelationshipType RelationshipType { get; set; }Property Value
| Type | Description |
|---|---|
| RecordRelationshipType | The type of the relationship. |
SourceRecordReference
Gets or sets the source record.
Declaration
public virtual IdentifierTriple SourceRecordReference { get; set; }Property Value
| Type | Description |
|---|---|
| IdentifierTriple | The source record. |
SourceVariable
The variable inside the source record that links to the target record.
Declaration
public Variable SourceVariable { get; set; }Property Value
| Type | Description |
|---|---|
| Variable |
Remarks
This is a single variable because, to be consistent, if multiple variables are used as a key they should be represented by a new Variable.
TargetRecordReference
Gets or sets the target record.
Declaration
public virtual IdentifierTriple TargetRecordReference { get; set; }Property Value
| Type | Description |
|---|---|
| IdentifierTriple | The target record. |
TargetVariable
The variable inside the TargetRecord that links to the source record.
Declaration
public Variable TargetVariable { get; set; }Property Value
| Type | Description |
|---|---|
| Variable |
Remarks
This is a single variable because, to be consistent, if multiple variables are used as a key they should be represented by a new Variable.
Methods
Accept(IVersionableVisitor)
Accepts the specified visitor.
Declaration
public virtual void Accept(IVersionableVisitor visitor)Parameters
| Type | Name | Description |
|---|---|---|
| IVersionableVisitor | visitor | The visitor. |
GetChildren()
Gets the children.
Declaration
public virtual ChildItemCollection GetChildren()Returns
| Type | Description |
|---|---|
| ChildItemCollection |
RemoveChild(IdentifierTriple)
Removes the child.
Declaration
public virtual int RemoveChild(IdentifierTriple child)Parameters
| Type | Name | Description |
|---|---|---|
| IdentifierTriple | child | The child. |
Returns
| Type | Description |
|---|---|
| System.Int32 |
ReplaceChild(IdentifierTriple, IVersionable)
Replaces the child.
Declaration
public virtual int ReplaceChild(IdentifierTriple toReplace, IVersionable child)Parameters
| Type | Name | Description |
|---|---|---|
| IdentifierTriple | toReplace | To replace. |
| IVersionable | child | The child. |
Returns
| Type | Description |
|---|---|
| System.Int32 |