Show / Hide Table of Contents

Class Ddi31LogicalRecord

Describes the logical data record.

Inheritance
object
NotificationObject
IdentifiableBase
LogicalRecord
Ddi31LogicalRecord
Implements
INotifyPropertyChanged
IDescribable
IVersionable
IIdentifiable
IHasCustomFields
IVisitable
Inherited Members
LogicalRecord.ItemName
LogicalRecord.Label
LogicalRecord.Description
LogicalRecord.DisplayLabel
LogicalRecord.HasLocator
LogicalRecord.LocatorVariableValue
LogicalRecord.CaseIdentifiers
LogicalRecord.VariablesInRecord
LogicalRecord.VariableSchemesInRecord
LogicalRecord.NCubeInRecord
LogicalRecord.WatchProperties()
IdentifiableBase.DefaultAgencyId
IdentifiableBase.AgencyId
IdentifiableBase.Identifier
IdentifiableBase.UserIds
IdentifiableBase.CustomFields
IdentifiableBase.UserAttributes
IdentifiableBase.GetUserIdValue(string)
IdentifiableBase.RemoveChildHelper(IdentifierTriple, params IList[])
NotificationObject.PropertyChanged
NotificationObject.RaisePropertyChanged(string)
NotificationObject.OnPropertyChanged(string)
NotificationObject.ResumePropertyEvents()
NotificationObject.SuspendPropertyEvents()
NotificationObject.PropertyEventsSuspended
NotificationObject.PropagateChildChanges(INotifyCollectionChanged, string)
NotificationObject.WatchProperty(INotifyPropertyChanged, string)
NotificationObject.WatchCollection(INotifyCollectionChanged, string)
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Algenta.Colectica.Model.Ddi.Compat
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class Ddi31LogicalRecord : LogicalRecord, INotifyPropertyChanged, IDescribable, IVersionable, IIdentifiable, IHasCustomFields, IVisitable

Constructors

Ddi31LogicalRecord()

Initializes a new instance of the LogicalRecord class.

Declaration
public Ddi31LogicalRecord()

Properties

Attachments

Gets a collection of file URIs stored in the File Storage Service attached to this item.

Declaration
public virtual ObservableCollection<Attachment> Attachments { get; }
Property Value
Type Description
ObservableCollection<Attachment>

BannerImageUri

Gets or sets the banner image for the item.

Declaration
public Uri BannerImageUri { get; set; }
Property Value
Type Description
Uri

BasedOn

Gets a collection that describes previous items on which this item is based

Declaration
public BasedOn BasedOn { get; set; }
Property Value
Type Description
BasedOn

ChildTypesAccepted

Gets the child types that may be added to this item type.

Declaration
public override Collection<Guid> ChildTypesAccepted { get; }
Property Value
Type Description
Collection<Guid>

The child types that may be added to this item type.

Overrides
LogicalRecord.ChildTypesAccepted

ChildrenDereferenced

Gets or sets a value indicating whether the item's children have been dereferenced.

Declaration
public bool ChildrenDereferenced { get; set; }
Property Value
Type Description
bool

true if the item's children have been dereferenced; otherwise, false.

CompositeId

Gets or sets the item's composite id, consisting of the agency identifier, identifier, and version.

Declaration
public IdentifierTriple CompositeId { get; set; }
Property Value
Type Description
IdentifierTriple

The item's composite identifier.

IsDirty

Gets or sets a value indicating whether this instance has unsaved changes.

Declaration
public virtual bool IsDirty { get; set; }
Property Value
Type Description
bool

true if this instance has unsaved changes; otherwise, false.

IsPopulated

Gets or sets a value indicating whether this instance's information is populated.

Declaration
public bool IsPopulated { get; set; }
Property Value
Type Description
bool

true if this instance is populated; otherwise, false.

IsPublished

Gets or sets a value indicating whether this instance is published.

Declaration
public bool IsPublished { get; set; }
Property Value
Type Description
bool

true if this instance is published; otherwise, false.

ItemType

Gets the universally unique identifier representing the item's type.

Declaration
public Guid ItemType { get; }
Property Value
Type Description
Guid

The identifier representing the item's type.

OtherMaterials

Gets a collection of Other Material fields defined for this item.

Declaration
public ObservableCollection<OtherMaterial> OtherMaterials { get; }
Property Value
Type Description
ObservableCollection<OtherMaterial>

SucceededBy

If another item should be preferred instead of this item.

Declaration
public TypedIdTriple SucceededBy { get; set; }
Property Value
Type Description
TypedIdTriple

ThumbnailImageUri

Gets or sets the thumbnail image for the item.

Declaration
public Uri ThumbnailImageUri { get; set; }
Property Value
Type Description
Uri

Version

Gets or sets the version.

Declaration
public long Version { get; set; }
Property Value
Type Description
long

The version.

VersionDate

Gets or sets the DateTime this version of the item was created.

Declaration
public DateTime VersionDate { get; set; }
Property Value
Type Description
DateTime

The DateTime this version was created.

VersionRationale

Gets the log message given by the user who created this version of the item.

Declaration
public MultilingualString VersionRationale { get; set; }
Property Value
Type Description
MultilingualString

VersionResponsibility

Gets or sets the name of the user who created this version of the item.

Declaration
public string VersionResponsibility { get; set; }
Property Value
Type Description
string

The name of the user who created this version of the item.

Methods

Accept(IVersionableVisitor)

Accepts the specified visitor.

Declaration
public override void Accept(IVersionableVisitor visitor)
Parameters
Type Name Description
IVersionableVisitor visitor

The visitor.

Overrides
LogicalRecord.Accept(IVersionableVisitor)

AddChild(IVersionable)

Adds the provided child to this item.

Declaration
public override void AddChild(IVersionable child)
Parameters
Type Name Description
IVersionable child

The item to be added as a child of this item.

Overrides
LogicalRecord.AddChild(IVersionable)
Exceptions
Type Condition
NotImplementedException

GetChildren()

Gets the identifiers of the item's children.

Declaration
public override ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection
Overrides
LogicalRecord.GetChildren()

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration
public override int RemoveChild(IdentifierTriple child)
Parameters
Type Name Description
IdentifierTriple child

The child to be removed.

Returns
Type Description
int

The number of children removed from the item.

Overrides
LogicalRecord.RemoveChild(IdentifierTriple)
Exceptions
Type Condition
ArgumentNullException

child

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child with the specified identifier with the provided item.

Declaration
public override int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
Type Name Description
IdentifierTriple toReplace

The identifier of the child to replace.

IVersionable child

The new child.

Returns
Type Description
int

The number of children replaced.

Overrides
LogicalRecord.ReplaceChild(IdentifierTriple, IVersionable)
Exceptions
Type Condition
ArgumentNullException

child

Implements

INotifyPropertyChanged
IDescribable
IVersionable
IIdentifiable
IHasCustomFields
IVisitable

Extension Methods

VersionableCustomFieldExtensions.GetCustomFieldMultilingualStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldUriValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, string)
Extensions.GetDdi32FragmentRepresentation(IVersionable, Ddi32Serializer)
Extensions.GetDdi33FragmentRepresentation(IVersionable, Ddi33Serializer)
Extensions.GetDdiFragmentRepresentation(IVersionable, DDIWorkflowSerializer, XmlDocument)
Extensions.GetMultilingualStrings(IVersionable)
NamingHelper.GetBaseFileNameForItem(IVersionable)
VersionableExtensions.GetHeader(IVersionable, bool)
VersionableExtensions.GetMetadata(IVersionable)
VersionableExtensions.GetUserAttribute(IVersionable, string)
VersionableExtensions.GetUserAttributeInt(IVersionable, string)
VersionableExtensions.SetUserAttribute(IVersionable, string, string)
VersionableUserIdExtensions.SetUserId(IVersionable, string, string)
In this article
Back to top Generated by DocFX