Inetdev Framework

IDescriptiveDataModel

Allows the implementation of a descriptive object. A descriptive object is an object that has a code or ID and a name or description, used to typify another object or objects.

Namespace:
Inetdev.Data
Type:
Interface
Public:
Yes
Protected:
No
Sealed:
No
Abstract:
Yes

Properties

TypeDescriptor

Description metadata for this type.

Signature:
public DescriptiveDataModelDescriptor TypeDescriptor { get; }

Methods

AddAsync

Create a new item.

Signature:
public Task<IDescriptiveDataModel> AddAsync(code, description)
Returns

Returns the newly created item.

Parameters
Name Type Summary
code String Item code.
description String Item description.

EditAsync

Create or modify the descriptive object.

Signature:
public Task<IDescriptiveDataModel> EditAsync(code, description)
Returns

Returns the edited item.

Parameters
Name Type Summary
code String Item code.
description String Item description.

FilterAsync

Returns a filtered list of items.

Signature:
public Task FilterAsync(query, take)
Parameters
Name Type Summary
query String Filter criteria.
take Int32 Maximum amount of objects to retrieve.

GetCode

Gets the item code.

Signature:
public String GetCode()

GetDescription

Gets the item description.

Signature:
public String GetDescription()

RemoveAsync

Removes an item from the underlaying repository.

Signature:
public Task<IDescriptiveDataModel> RemoveAsync(code)
Returns

Returns the removed item.

Parameters
Name Type Summary
code String Item code.

In this document