Skip to content

Latest commit

 

History

History
223 lines (158 loc) · 8.01 KB

General.Geography.GeoPoints.md

File metadata and controls

223 lines (158 loc) · 8.01 KB
uid
General.Geography.GeoPoints

General.Geography.GeoPoints Entity

Namespace: General.Geography

Geographical (geo) points are used as points of interest on the map. They are used for routing and other purposes. The points of interest for the different enterprise companies are different. Entity: Gen_Geo_Points

Default Visualization

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

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
Address string (128) nullable The descriptive physical address, related to this geo point. Filter(eq;like)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
Latitude decimal (10, 7) Latitude is the vertical angle from equator to the pole of the point. Positive values denote points north of the equator. The value is in the range -90, 90. Required Default(0) Filter(eq;ge;le)
Longitude decimal (10, 7) Longitude is angle from the prime meridian (in England) in east-west direction. Positive values denote east and negative - west. The value is in the range -180, 180. Required Default(0) Filter(eq;ge;le)
Name MultilanguageString (128) Geo point short name (Multilanguage). Required Filter(eq;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.

References

Name Type Description
EnterpriseCompany EnterpriseCompanies (nullable) The enterprise company for which the name of the geo point has meaning. Null for geo points not related to specific enterprise company. Filter(multi eq)

Attribute Details

Address

The descriptive physical address, related to this geo point. Filter(eq;like)

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

Latitude

Latitude is the vertical angle from equator to the pole of the point. Positive values denote points north of the equator. The value is in the range -90, 90. Required Default(0) Filter(eq;ge;le)

Type: decimal (10, 7)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Longitude

Longitude is angle from the prime meridian (in England) in east-west direction. Positive values denote east and negative - west. The value is in the range -180, 180. Required Default(0) Filter(eq;ge;le)

Type: decimal (10, 7)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Name

Geo point short name (Multilanguage). Required Filter(eq;like)

Type: MultilanguageString (128)
Category: System
Supported Filters: Equals, Like
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

Reference Details

EnterpriseCompany

The enterprise company for which the name of the geo point has meaning. Null for geo points not related to specific enterprise company. Filter(multi eq)

Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
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

[!list limit=1000 erp.entity=General.Geography.GeoPoints erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=General.Geography.GeoPoints erp.type=front-end-business-rule default-text="None"]

API

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

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