WebModule Class

The abstract basic building block of web sites. Each module can render multiple web pages. Entity: Cms_Web_Modules

Inheritance Hierarchy

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.Applications.CmsWebModule
            Aloe.EnterpriseOne.Model.Applications.CmsNewsWebModule
            Aloe.EnterpriseOne.Model.Applications.CmsProductCatalogWebModule
            Aloe.EnterpriseOne.Model.Applications.CmsStaticWebModule

Namespace: Aloe.EnterpriseOne.Model.Applications.Cms
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public abstract class WebModule : EnterpriseOneEntityObject

Public MustInherit Class WebModule
	Inherits EnterpriseOneEntityObject

public ref class WebModule abstract : public EnterpriseOneEntityObject

[<AbstractClassAttribute>]
type WebModule =  
    class
        inherit EnterpriseOneEntityObject
    end

The WebModule type exposes the following members.

Properties

	Name	Description
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	IsGhost	Returns true when the object is a ghost object (Inherited from EntityObject.)
	IsLoaded	Gets a value indicating whether the associated data for this domain object is loaded. (Overrides EntityObjectIsLoaded.)
	IsPublished	Specifies whether the module is published and will be showed in the web site. [Required] [Default(false)] [Filter(eq)]
	ItemString	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	ItemIDataAttribute	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	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)]
	ModulePicture	Default picture. Used for picture links, small module icons, etc. PNG format is suggested.
	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)]
	Name	Multilanguage Module name. This is used as a title when displaying the web Module. [Required] [Filter(like)]
	NoEvents	Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info. (Inherited from DomainObject.)
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	Parent	The parent web Module. It can only be a module with Module Type = Category. Null means that the web Module is root web Module. [Filter(multi eq)]
	Repository	Provides access to WebModulesRepository repository methods
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	WebModuleId	Gets the Id of the webmodule row, related to the domain object
	WebSite	The web site to which the module belongs. [Required] [Filter(multi eq)] [Owner]

Top

Methods

	Name	Description
	Delete	Deletes the domain object. (Overrides EntityObjectDelete.)
	DuplicateObject	Creates a copy of the object. (Inherited from EntityObject.)
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Inherited from EntityObject.)
	Equals(EntityObject)	Indicates whether the current object is equal to another object of the same type. (Inherited from EntityObject.)
	ExecuteBusinessRules	Executes all business rules for the object for the specified BusinessEvent. The validation fails are saved in the event. (Inherited from EditableDomainObject.)
	GetAggregateParent	Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null. (Inherited from EntityObject.)
	GetAggregateRoot	Gets the aggregate root entity object. If the entity does not have aggregate parent reference aggregate root is this entity object. (Inherited from EntityObject.)
	GetHashCode	Returns a hash code for this instance. (Inherited from EntityObject.)
	GetRelatedObjectsForValidation	Gets the related objects which would need validation upon validation of this object. (Inherited from EntityObject.)
	IssueWarning(String)	Issues a warning with the specified message. (Inherited from EditableDomainObject.)
	IssueWarning(ExpressionFuncString, Object)	Issues a warning with the specified message. The message can contain standard string placeholders. (Inherited from EditableDomainObject.)
	MatchesFilter(DataAccessFilter)	Returns true if this entity object matches the specified filter. (Inherited from EnterpriseOneEntityObject.)
	MatchesFilter(DataAccessFilter, IBufferRow)	Matches the filter against the specified row and returns the result of the match. (Inherited from EnterpriseOneEntityObject.)
	Refresh	Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed. (Inherited from EntityObject.)
	ToString	Returns a String that represents this instance. (Inherited from EntityObject.)
	ToString(String)	Returns a String that represents this instance. (Inherited from EntityObject.)
	TryGet	Tries to get the specified attribute and returns it or null, when it is not found. (Inherited from DomainObject.)

Top

Extension Methods

	Name	Description
	FillAggregateMissingDefaults	Recalculates the default values for all objects in the aggregate. (Defined by EntityObjectExtensions.)
	FillMissingDefaults	Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default. (Defined by EntityObjectExtensions.)
	FormatString	Converts the object to string based on the format specified. (Defined by FormatStringExtensions.)
	GetExtensibleDataObject	Gets the extensible data object related to the entity object. Can return null if such ExtensibleDataObject doesn't exist. (Defined by ExtensibleDataObjectExtensions.)
	GetOrCreateExtensibleDataObject	Returns an ExtensibleDataObject related to the entity object. If such object doesn't exist the object is created in the same transaction. (Defined by ExtensibleDataObjectExtensions.)
	RecalculateMasterAttributes	Recalculates the values of a master attributes in a master-detail relationship. (Defined by EntityObjectExtensions.)
	RecalculateMissingValues	Recalculates the missing values using the first reactive expression of the attributes. (Defined by EntityObjectExtensions.)

Top

Reference

Aloe.EnterpriseOne.Model.Applications.Cms Namespace