Projects.TodoTasks Entity
Namespace: Projects
Default Visualization
Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
Name | Type | Description |
---|---|---|
CompletedDateTimeUtc | datetime nullable | Indicates (in UTC) when the task was completed. Filter(eq;ge;le) ReadOnly |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
DueDate | date nullable | Indicates when the task should be finished. Filter(eq;ge;le) |
Id | guid | |
Importance | Importance | The importance of the task. Required Default("N") Filter(eq) |
Name | string (254) nullable | A brief description of the task. Filter(like) |
ObjectVersion | int32 | The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking. |
RemindTime | datetimeoffset nullable | When to remind the assigned user for the task. |
State | State | Indicates the current task state. Required Default("N") Filter(eq) |
References
Name | Type | Description |
---|---|---|
AssignedToUser | Users | The user, to whom the todo is assigned. Required Filter(multi eq) |
OwnerUser | Users | The user, who created the todo and owns it. Required Filter(multi eq) |
SocialGroup | Groups (nullable) | When not null, indicates that the todo is contained in and managed by the specified social group. Filter(multi eq) |
Child Collections
Name | Type | Description |
---|---|---|
Items | TodoTaskItems | List of TodoTaskItem (Projects.TodoTaskItems.md) child objects, based on the Projects.TodoTaskItem.TodoTask (Projects.TodoTaskItems.md#todotask) back reference |
Attribute Details
CompletedDateTimeUtc
Indicates (in UTC) when the task was completed. Filter(eq;ge;le)
ReadOnly
Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
DisplayText
Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
DueDate
Indicates when the task should be finished. Filter(eq;ge;le)
Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Importance
The importance of the task. Required
Default("N")
Filter(eq)
Type: Importance
Category: System
Allowed values for the Importance
(Projects.TodoTasks.md#importance) data attribute
Allowed Values (Projects.TodoTasksRepository.Importance Enum Members)
Value | Description |
---|---|
Low | Low value. Stored as 'L'. Database Value: 'L' Model Value: 0 Domain API Value: 'Low' |
Normal | Normal value. Stored as 'N'. Database Value: 'N' Model Value: 1 Domain API Value: 'Normal' |
High | High value. Stored as 'H'. Database Value: 'H' Model Value: 2 Domain API Value: 'High' |
Supported Filters: Equals
Supports Order By: False
Default Value: Normal
Name
A brief description of the task. Filter(like)
Type: string (254) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 254
ObjectVersion
The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
RemindTime
When to remind the assigned user for the task.
Type: datetimeoffset nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
State
Indicates the current task state. Required
Default("N")
Filter(eq)
Type: State
Category: System
Allowed values for the State
(Projects.TodoTasks.md#state) data attribute
Allowed Values (Projects.TodoTasksRepository.State Enum Members)
Value | Description |
---|---|
New | The task is new and its execution is pending. Stored as 'N'. Database Value: 'N' Model Value: 0 Domain API Value: 'New' |
InProgress | The task is in progress.. Stored as 'P'. Database Value: 'P' Model Value: 1 Domain API Value: 'InProgress' |
Waiting | The task is pending.. Stored as 'W'. Database Value: 'W' Model Value: 2 Domain API Value: 'Waiting' |
Completed | The task is done.. Stored as 'C'. Database Value: 'C' Model Value: 3 Domain API Value: 'Completed' |
Supported Filters: Equals
Supports Order By: False
Default Value: New
Reference Details
AssignedToUser
The user, to whom the todo is assigned. Required
Filter(multi eq)
Type: Users
Category: System
Supported Filters: Equals, EqualsIn
OwnerUser
The user, who created the todo and owns it. Required
Filter(multi eq)
Type: Users
Category: System
Supported Filters: Equals, EqualsIn
SocialGroup
When not null, indicates that the todo is contained in and managed by the specified social group. Filter(multi eq)
Type: Groups (nullable)
Category: System
Supported Filters: Equals, EqualsIn
API Methods
Methods that can be invoked in public APIs.
GetAllowedCustomPropertyValues
Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET
Parameters
customPropertyCode
The code of the custom property
Type: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0
CreateNotification
Creates a notification a sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST
Parameters
user
The user.
Type: UsersnotificationClass
The notification class.
Type: stringsubject
The subject.
Type: string
CreateCopy
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
Business Rules
None
Front-End Business Rules
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Projects_TodoTasks?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Projects_TodoTasks?$top=10