Class IdentifiableBase
Defines identification information for an item. Implements IIdentifiable.
Inherited Members
Namespace: Algenta.Colectica.Model
Assembly: Algenta.Colectica.Model.dll
Syntax
public abstract class IdentifiableBase : NotificationObject, INotifyPropertyChanged, IIdentifiable, IHasCustomFieldsConstructors
IdentifiableBase()
Initializes a new instance of the IdentifiableBase class.
Declaration
protected IdentifiableBase()Properties
AgencyId
Gets or sets the agency identifier of the item.
Declaration
[Display(GroupName = "Basic", Order = 0)]
public string AgencyId { get; set; }Property Value
| Type | Description |
|---|---|
| string | The agency identifier of the item. |
CustomFields
Gets a collection of custom fields defined for this item.
Declaration
public ObservableCollection<CustomField> CustomFields { get; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<CustomField> |
DefaultAgencyId
Gets or sets the default agency ID to be used when creating new VersionableBase-derived instances.
Declaration
public static string DefaultAgencyId { get; set; }Property Value
| Type | Description |
|---|---|
| string | The default agency id. |
Identifier
Gets or sets the universally unique identifier of the item.
Declaration
[Display(GroupName = "Basic", Order = 0)]
public Guid Identifier { get; set; }Property Value
| Type | Description |
|---|---|
| Guid | The identifier of the item. |
UserAttributes
Gets a collection of user defined fields defined for this item.
Declaration
public ObservableCollection<UserAttribute> UserAttributes { get; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<UserAttribute> |
UserIds
Gets the user-specified identifiers.
Declaration
public UserIdCollection UserIds { get; }Property Value
| Type | Description |
|---|---|
| UserIdCollection |
Methods
GetChildren()
Gets the identifiers of the item's children.
Declaration
public virtual ChildItemCollection GetChildren()Returns
| Type | Description |
|---|---|
| ChildItemCollection | The identifiers of the item's children. |
GetUserIdValue(string)
Gets the user value of the user identifier of the specified type.
Declaration
public string GetUserIdValue(string type)Parameters
| Type | Name | Description |
|---|---|---|
| string | type | The type of user identifier for which the value is returned. |
Returns
| Type | Description |
|---|---|
| string | The value of the user identifier with the specified type. |
RemoveChild(IdentifierTriple)
Removes the specified child.
Declaration
public virtual 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. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | child |
RemoveChildHelper(IdentifierTriple, params IList[])
Removes the child with the specified identifier from any of the provided lists.
Declaration
public static int RemoveChildHelper(IdentifierTriple itemToRemove, params IList[] lists)Parameters
| Type | Name | Description |
|---|---|---|
| IdentifierTriple | itemToRemove | The identifier of the item to remove. |
| IList[] | lists | The lists. |
Returns
| Type | Description |
|---|---|
| int |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | itemToRemove |
ReplaceChild(IdentifierTriple, IVersionable)
Replaces the child with the specified identifier with the provided item.
Declaration
public virtual 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. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | child |
WatchProperties()
Watch for property changed events
Declaration
protected override void WatchProperties()