General.Contacts.CompanyEmployees Entity

Namespace: General.Contacts

Contains the company employee contracts. Entity: Cm_Company_Employees

Default Visualization

Default Display Text Format:
{Person.PartyName:T}
Default Search Members:
ContractCode; Person.PartyName
Code Data Member:
ContractCode
Name Data Member:
Person.PartyName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Parent:
General.Contacts.Persons
Aggregate Root:
General.Contacts.Persons

Attributes

Name Type Description
ContractCode string (16) nullable Contract number or code, unique within the company. One employee can have more than one contract. Filter(eq)
ContractEndDate datetime nullable End date of the employee contract, null if the contract is still valid. Filter(ge;le)
ContractStartDate datetime nullable Start date of the employee contract. Null if it is unkown. Filter(ge;le)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
Notes string (254) nullable Notes for this CompanyEmployee.
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.

References

Name Type Description
Company Companies The company for which this employee works. Required Filter(multi eq)
CompanyDepartment CompanyDepartments (nullable) The department in which this employee is working. null means this information is unknown. Filter(multi eq)
Person Persons The personal data of the employee. Required Filter(multi eq) Owner

Attribute Details

ContractCode

Contract number or code, unique within the company. One employee can have more than one contract. Filter(eq)

Type: string (16) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

ContractEndDate

End date of the employee contract, null if the contract is still valid. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ContractStartDate

Start date of the employee contract. Null if it is unkown. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

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

Notes

Notes for this CompanyEmployee.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
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

Reference Details

Company

The company for which this employee works. Required Filter(multi eq)

Type: Companies
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

CompanyDepartment

The department in which this employee is working. null means this information is unknown. Filter(multi eq)

Type: CompanyDepartments (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Person

The personal data of the employee. Required Filter(multi eq) Owner

Type: Persons
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

Creates a notification and sends 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 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

Front-End Business Rules

None

API

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

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