General.Resources.WorkSchedules Entity

Namespace: General.Resources

Represents the different working schedules, used by the employees and resources. Entity: Gen_Work_Schedules

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

• General.Resources.WorkSchedules
  • General.Resources.WorkScheduleWorkingTime

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Name	string (64)	The name of this WorkSchedule. Required Filter(like)
NumberOfDays	int16 nullable	Number of days in a recurring period. Valid only when Recurrence_Type=D.
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.
RecurrenceType	RecurrenceType	D=recurring each X days; W=recurring each week; M=recurring each month. Required Filter(multi eq)

Child Collections

Name	Type	Description
WorkingTime	WorkScheduleWorkingTime	List of WorkScheduleWorkingTime(General.Resources.WorkScheduleWorkingTime.md) child objects, based on the General.Resources.WorkScheduleWorkingTime.WorkSchedule(General.Resources.WorkScheduleWorkingTime.md#workschedule) back reference

Attribute Details

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: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Name

The name of this WorkSchedule. Required Filter(like)

Type: string (64)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

NumberOfDays

Number of days in a recurring period. Valid only when Recurrence_Type=D.

Type: int16 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

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: ****
Show in UI: HiddenByDefault

RecurrenceType

D=recurring each X days; W=recurring each week; M=recurring each month. Required Filter(multi eq)

Type: RecurrenceType
Category: System
Allowed values for the RecurrenceType(General.Resources.WorkSchedules.md#recurrencetype) data attribute
Allowed Values (General.Resources.WorkSchedulesRepository.RecurrenceType Enum Members)

Value	Description
RecurringEachXDays	RecurringEachXDays value. Stored as 'D'. Database Value: 'D' Model Value: 0 Domain API Value: 'RecurringEachXDays'
RecurringEachMonth	RecurringEachMonth value. Stored as 'M'. Database Value: 'M' Model Value: 1 Domain API Value: 'RecurringEachMonth'
RecurringEachWeek	RecurringEachWeek value. Stored as 'W'. Database Value: 'W' Model Value: 2 Domain API Value: 'RecurringEachWeek'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

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: string

• search
  The search text - searches by value or description. Can contain wildcard character %.
  Type: string
  Optional: True
  Default Value: null

• exactMatch
  If true the search text should be equal to the property value
  Type: boolean
  Optional: True
  Default Value: False

• orderByDescription
  If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
  Type: boolean
  Optional: True
  Default Value: False

• top
  The top clause - default is 10
  Type: int32
  Optional: True
  Default Value: 10

• skip
  The skip clause - default is 0
  Type: int32
  Optional: True
  Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

• user
  The user.
  Type: Users

• notificationClass
  The notification class.
  Type: string

• subject
  The notification 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

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_Resources_WorkSchedules?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_Resources_WorkSchedules?$top=10