Class DdiInstance
Represents the top-level wrapper of a DDI 3 document.
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class DdiInstance : VersionableBase, IVersionable, IIdentifiable, IHasCustomFields, IVisitable, IDescribable, IDublinCoreDescribableConstructors
DdiInstance()
Initializes a new instance of the DdiInstance class.
Declaration
public DdiInstance()Properties
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
Description
Gets the description.
Declaration
public MultilingualString Description { get; }Property Value
| Type | Description |
|---|---|
| MultilingualString |
Implements
DisplayLabel
Gets the display label.
Declaration
public override string DisplayLabel { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
DublinCoreMetadata
Gets the Dublin Core metadata.
Declaration
public DublinCore DublinCoreMetadata { get; set; }Property Value
| Type | Description |
|---|---|
| DublinCore |
Implements
Groups
Gets or sets the groups contained in the DDIInstance.
Declaration
public ObservableCollection<Group> Groups { get; set; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<Group> |
ItemName
Gets the name of the item.
Declaration
public MultilingualString ItemName { get; }Property Value
| Type | Description |
|---|---|
| MultilingualString |
Implements
ItemType
Gets the universally unique identifier representing the item's type.
Declaration
public override Guid ItemType { get; }Property Value
| Type | Description |
|---|---|
| Guid | The identifier representing the item's type. |
Overrides
Label
Gets the label.
Declaration
public MultilingualString Label { get; }Property Value
| Type | Description |
|---|---|
| MultilingualString |
Implements
ResourcePackages
Gets or sets the resource packages contained in the DDIInstance.
Declaration
public ObservableCollection<ResourcePackage> ResourcePackages { get; set; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<ResourcePackage> |
StudyUnits
Gets or sets the study units contained in the DDIInstance.
Declaration
public ObservableCollection<StudyUnit> StudyUnits { get; set; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<StudyUnit> |
Methods
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
GetChildren()
Gets the identifiers of the item's children.
Declaration
public override ChildItemCollection GetChildren()Returns
| Type | Description |
|---|---|
| ChildItemCollection | The identifiers of the item's children. |
Overrides
GetDefaultResourcePackage()
Gets the first resource package. If a resource package does not exist, one is created.
Declaration
public ResourcePackage GetDefaultResourcePackage()Returns
| Type | Description |
|---|---|
| ResourcePackage | The first, or newly created, resource package. |
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 |
|---|---|
| System.Int32 | The number of children removed from the item. |
Overrides
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 |
|---|---|
| System.Int32 | The number of children replaced. |