Skip to content

Latest commit

 

History

History
271 lines (193 loc) · 11.7 KB

Applications.Cms.ProductCatalogWebModules.md

File metadata and controls

271 lines (193 loc) · 11.7 KB
Raw
uid
Applications.Cms.ProductCatalogWebModules

Applications.Cms.ProductCatalogWebModules Entity

Namespace: Applications.Cms
Inherited From: Applications.Cms.WebModules

A web module, which presents a whole product catalog. Entity: Cms_Product_Catalog_Web_Modules (Obsoleted in version 22.1.6.73)

Note

OBSOLETE! Do not use!

Default Visualization

Default Display Text Format:
{Name}
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 Parent:
Applications.Cms.WebSites
Aggregate Root:
Applications.Cms.WebSites

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
IsPublished boolean Specifies whether the module is published and will be showed in the web site. Required Default(false) Filter(eq) (Inherited from WebModules)
LocalUrl string (128) nullable The local Module Url. The full Url of a module is formed based on the sites Base Url, the local Urls of all parent modules and the module Local Url. Null means that the web Module is the default web module within the parent path. Filter(like) (Inherited from WebModules)
ModulePicture byte[] nullable Default picture. Used for picture links, small module icons, etc. PNG format is suggested. (Inherited from WebModules)
ModuleType ModuleType Specifies the content handler. The content handler is responsible for generating the actual web page content. Module Types include Category, Static, News, Product, etc. Required Filter(like) (Inherited from WebModules)
Name string (512) Multilanguage Module name. This is used as a title when displaying the web Module. Required Filter(like) (Inherited from WebModules)
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
Parent WebModules (nullable) OBSOLETE! Do not use! The parent web Module. It can only be a module with Module Type = Category. Null means that the web Module is root web Module. Obsolete Filter(multi eq) Obsoleted in version 24.1.5.20 Obsolete (Inherited from WebModules)
ProductCatalog ProductCatalogs The product catalog, which is represented by this web module. Required Filter(multi eq)
WebSite WebSites OBSOLETE! Do not use! The web site to which the module belongs. Obsolete Required Filter(multi eq) Obsoleted in version 24.1.5.20 Obsolete Owner (Inherited from WebModules)

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

IsPublished

Specifies whether the module is published and will be showed in the web site. Required Default(false) Filter(eq) (Inherited from WebModules)

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

LocalUrl

The local Module Url. The full Url of a module is formed based on the sites Base Url, the local Urls of all parent modules and the module Local Url. Null means that the web Module is the default web module within the parent path. Filter(like) (Inherited from WebModules)

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

ModulePicture

Default picture. Used for picture links, small module icons, etc. PNG format is suggested. (Inherited from WebModules)

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

ModuleType

Specifies the content handler. The content handler is responsible for generating the actual web page content. Module Types include Category, Static, News, Product, etc. Required Filter(like) (Inherited from WebModules)

Type: ModuleType
Category: System
Allowed values for the ModuleType data attribute
Allowed Values (Applications.Cms.WebModulesRepository.ModuleType Enum Members)

Value Description
CategoryPage CategoryPage value. Stored as 'CAT'.
Database Value: 'CAT'
Model Value: 0
Domain API Value: 'CategoryPage'
Static Static value. Stored as 'STA'.
Database Value: 'STA'
Model Value: 1
Domain API Value: 'Static'
News News value. Stored as 'NEW'.
Database Value: 'NEW'
Model Value: 2
Domain API Value: 'News'

Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

Name

Multilanguage Module name. This is used as a title when displaying the web Module. Required Filter(like) (Inherited from WebModules)

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

Parent

OBSOLETE! Do not use! The parent web Module. It can only be a module with Module Type = Category. Null means that the web Module is root web Module. Obsolete Filter(multi eq) Obsoleted in version 24.1.5.20 Obsolete (Inherited from WebModules)

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

ProductCatalog

The product catalog, which is represented by this web module. Required Filter(multi eq)

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

WebSite

OBSOLETE! Do not use! The web site to which the module belongs. Obsolete Required Filter(multi eq) Obsoleted in version 24.1.5.20 Obsolete Owner (Inherited from WebModules)

Type: WebSites
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

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

Front-End Business Rules

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

API

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

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