Skip to content

Latest commit

 

History

History
238 lines (168 loc) · 8.4 KB

Applications.Cms.NewsWebModuleArticles.md

File metadata and controls

238 lines (168 loc) · 8.4 KB
Raw
uid
Applications.Cms.NewsWebModuleArticles

Applications.Cms.NewsWebModuleArticles Entity

Namespace: Applications.Cms

Represents an article in a news web module. Entity: Cms_News_Web_Module_Articles (Obsoleted in version 22.1.6.73)

Note

OBSOLETE! Do not use!

Default Visualization

Default Display Text Format:
{LanguageCode}
Default Search Members:
LanguageCode
Code Data Member:
LanguageCode
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
ArticleTextHtml string (max) nullable The actual article text, stored as Html. Only the <BODY> of the Html is stored. The language of the text is specified in Language Code.
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsPublished boolean Specifies whether the article is published for display on web. Required Default(false)
LanguageCode string (8) The language code of the article text. Required
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.
PublishDate datetime The date and time when the news article should appear to be published. Required Default(Now) Filter(ge;le)

References

Name Type Description
AuthorPublicUser PublicUsers OBSOLETE! Do not use! The author of the news article. Obsolete Required Filter(multi eq) Obsoleted in version 24.1.4.88 Obsolete
NewsWebModule NewsWebModules OBSOLETE! Do not use! The News Web Module, to which the current article is added. Obsolete Required Filter(multi eq) Obsoleted in version 24.1.4.88 Obsolete

Attribute Details

ArticleTextHtml

The actual article text, stored as Html. Only the <BODY> of the Html is stored. The language of the text is specified in Language Code.

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

IsPublished

Specifies whether the article is published for display on web. Required Default(false)

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LanguageCode

The language code of the article text. Required

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

PublishDate

The date and time when the news article should appear to be published. Required Default(Now) Filter(ge;le)

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

Reference Details

AuthorPublicUser

OBSOLETE! Do not use! The author of the news article. Obsolete Required Filter(multi eq) Obsoleted in version 24.1.4.88 Obsolete

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

NewsWebModule

OBSOLETE! Do not use! The News Web Module, to which the current article is added. Obsolete Required Filter(multi eq) Obsoleted in version 24.1.4.88 Obsolete

Type: NewsWebModules
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=Applications.Cms.NewsWebModuleArticles erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Applications.Cms.NewsWebModuleArticles erp.type=front-end-business-rule default-text="None"]

API

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

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