Table of Contents

Interface IDataObjectApiService

Namespace: Casewhere.Runtime.Api
Assembly: Casewhere.Runtime.dll

public interface IDataObjectApiService

Extension Methods

ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<IDataObjectApiService>(IDataObjectApiService)

Methods

Add(WorkflowContext, string, object, bool)

DataObject Add(WorkflowContext context, string dataClass, object data, bool notifyChange = true)

Parameters

context WorkflowContext

dataClass string

data object

notifyChange bool

Returns

DataObject

AddExternal(Case, Workflow, object, bool)

DataObject AddExternal(Case @case, Workflow workflow, object data, bool forcePersistent = true)

Parameters

case Case

workflow Workflow

data object

forcePersistent bool

Returns

DataObject

Any(string, BsonDocument)

bool Any(string dataClassName, BsonDocument filter)

Parameters

dataClassName string

filter BsonDocument

Returns

bool

ChangeCreator(WorkflowContext, DOId, string)

void ChangeCreator(WorkflowContext context, DOId id, string value)

Parameters

context WorkflowContext

id DOId

value string

Count(string, BsonDocument)

long Count(string dataClassName, BsonDocument filter)

Parameters

dataClassName string

filter BsonDocument

Returns

long

Delete(WorkflowContext, DOId, bool)

void Delete(WorkflowContext context, DOId id, bool notifyChange = true)

Parameters

context WorkflowContext

id DOId

notifyChange bool

Enumerate(EnumerationDataObjectQuery, CancellationToken)

IEnumerable<DynamicDataObject> Enumerate(EnumerationDataObjectQuery query, CancellationToken cancellationToken)

Parameters

query EnumerationDataObjectQuery

cancellationToken CancellationToken

Returns

IEnumerable<DynamicDataObject>

HardDelete(IList<DOId>)

void HardDelete(IList<DOId> ids)

Parameters

ids IList<DOId>

Inc(WorkflowContext, DOId, string, dynamic)

void Inc(WorkflowContext context, DOId id, string attributeName, dynamic value)

Parameters

context WorkflowContext

id DOId

attributeName string

value dynamic

Load(DOId, bool)

DynamicDataObject Load(DOId id, bool forceReload = false)

Parameters

id DOId

forceReload bool

Returns

DynamicDataObject

Migrate(WorkflowContext, DOId, object, bool)

DataObject Migrate(WorkflowContext context, DOId doId, object data, bool notifyChange = true)

Parameters

context WorkflowContext

doId DOId

data object

notifyChange bool

Returns

DataObject

Migrate(DOMigrationContext)

DataObject Migrate(DOMigrationContext migrationContext)

Parameters

migrationContext DOMigrationContext

Returns

DataObject

MoveToCase(WorkflowContext, DOId, Guid)

void MoveToCase(WorkflowContext context, DOId id, Guid caseId)

Parameters

context WorkflowContext

id DOId

caseId Guid

Pull(WorkflowContext, DOId, string, params object[])

void Pull(WorkflowContext context, DOId id, string propertyName, params object[] data)

Parameters

context WorkflowContext

id DOId

propertyName string

data object[]

Push(WorkflowContext, DOId, string, params object[])

void Push(WorkflowContext context, DOId id, string propertyName, params object[] data)

Parameters

context WorkflowContext

id DOId

propertyName string

data object[]

Search(PagedDataObjectQuery)

DataObjectsSearchResult Search(PagedDataObjectQuery dataObjectQuery)

Parameters

dataObjectQuery PagedDataObjectQuery

Returns

DataObjectsSearchResult

Search(string, IList<DOId>)

DataObjectsSearchResult Search(string dataClassName, IList<DOId> dataObjectIds)

Parameters

dataClassName string

dataObjectIds IList<DOId>

Returns

DataObjectsSearchResult

Search(string, string, string, DataObjectExpression, int, int)

[Obsolete]
DataObjectsSearchResult Search(string dataClassName, string processName, string workflowName, DataObjectExpression doExpression, int skip = 0, int take = 0)

Parameters

dataClassName string

processName string

workflowName string

doExpression DataObjectExpression

skip int

take int

Returns

DataObjectsSearchResult

Search(DOReadContext, IList<DOId>)

DataObjectsSearchResult Search(DOReadContext context, IList<DOId> dataObjectIds)

Parameters

context DOReadContext

dataObjectIds IList<DOId>

Returns

DataObjectsSearchResult

Search(DOId, bool)

DynamicDataObject Search(DOId dOId, bool includeDeleted = false)

Parameters

dOId DOId

includeDeleted bool

Returns

DynamicDataObject

TryLoadIncludeDeleted(DOId)

DynamicDataObject TryLoadIncludeDeleted(DOId id)

Parameters

id DOId

Returns

DynamicDataObject

Update(WorkflowContext, DOId, object, bool)

void Update(WorkflowContext context, DOId id, object data, bool notifyChange = true)

Parameters

context WorkflowContext

id DOId

data object

notifyChange bool

Update(DOMigrationContext)

void Update(DOMigrationContext migrationContext)

Parameters

migrationContext DOMigrationContext