BusinessObjectBase Members
The BusinessObjectBase type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
AddSearchableProperty |
Adds the property and value to the searchable index. Property may be any created element
|
|
|
AddSummaryDataRow(String, String) |
Adds the data to the summary data used to display in the tool list. Property may be any created element.
|
|
|
AddSummaryDataRow(String, Int32) |
Adds the data to the summary data used to display in the tool list. Property may be any created element.
|
|
|
AddSummaryDataRow(String, Guid) |
Adds the data to the summary data used to display in the tool list. Property may be any created element.
|
|
|
AddSummaryDataRow(String, Boolean) |
Adds the data to the summary data used to display in the tool list. Property may be any created element.
|
|
|
AddSummaryDataRow(String, DateTime) |
Adds the data to the summary data used to display in the tool list. Property may be any created element.
|
|
|
AddSummaryDataRow(String, Decimal) |
Adds the data to the summary data used to display in the tool list. Property may be any created element.
|
|
|
AddSummaryDataRow(String, Object) |
Adds the data to the summary data used to display in the tool list. Property may be any created element.
|
|
AreXElementsEqualCustom |
Custom equality check for two XElement trees that treats
missing and whitespace-only nodes as equal to null. Used by the diff/equality
helpers for business-object comparison.
|
|
|
CompareTopLevelElements<(Of <<'(T>)>>) |
Compares the top-level children of two XML trees and returns a list of human-readable
difference strings. Each string mentions the source and
target names so the output is caller-friendly.
|
|
|
GetDifferences<(Of <<'(T>)>>) |
Produces a list of differences between this object and obj
after stripping framework-owned nodes and empty ones — used to show users what
changed between two versions of the same record.
|
|
|
GetFriendlyNameForProperty |
Gets the friendly display name for a property using its DisplayAttribute, if present.
The lookup is case-insensitive and supports the GetName path so
values pulled from a resource file are returned localized.
|
|
GetPropertyName<(Of <<'(T>)>>)(Expression<(Of <<'(Func<(Of <<'(T>)>>)>)>>)) |
Returns the name of the property referenced by a closure-style lambda — useful when you
already have an instance in scope and want a refactor-safe property name string instead
of a magic literal.
|
|
|
GetPropertyName<(Of <<'(TObject>)>>)(Expression<(Of <<'(Func<(Of <<'(TObject, Object>)>>)>)>>)) |
Returns the name of a property selected from TObject — useful when
you don't have an instance handy but want a refactor-safe property name string. Works for
both reference- and value-typed properties (boxing conversions are unwrapped automatically).
|
|
|
GetPropertyNameCore |
Resolves the property name from a property-reference expression, supporting both direct
member access and value-type-conversion wrappers. This is the underlying worker used by
[GetPropertyName{TObject}(Expression{Func{TObject, object}})]; derived classes
can call it directly when working with an already-built Expression tree.
|
|
|
GetPublicProperties |
Gets all public readable and writable properties of the current object, optionally including those marked with XmlIgnoreAttribute.
|
|
|
IsEmptyOrMissingNode |
Returns true when e is present but carries no children,
attributes, or non-whitespace value — the semantic equivalent of "not there."
|
|
|
IsEqual<(Of <<'(T>)>>) |
Returns true when this is considered equal to obj
after ignoring framework-owned nodes and whitespace-only elements.
|
|
|
IsValidDate |
Helper method to determine if a string value is a valid DateTime.
|
|
|
IsValidGuid |
Helper method to determine if a string value is a valid Guid.
|
|
|
IsValidInt |
Helper method to determine if a string value is a valid integer.
|
|
|
OnLoad |
Automatically called when the object is requested through AdvantageModuleEngine or ToolEngine.
Can be used to perform external actions or load reference data.
|
|
|
PostDeleteDraft |
Called by AdvantageCSP after deleting a draft of the object.
|
|
|
PostDeleteRecord |
Called by AdvantageCSP after deleting the entire object (all versions).
|
|
|
PostPublish |
Called by AdvantageCSP after publishing the object.
|
|
|
PostSaveDraft |
Called by AdvantageCSP after saving a draft of the object.
|
|
|
PostUnpublish |
Called by AdvantageCSP after un-publishing the object.
|
|
|
PreDeleteDraft |
Called by AdvantageCSP prior to deleting a draft of the object.
|
|
|
PreDeleteRecord |
Called by AdvantageCSP prior to deleting the entire object (all versions).
|
|
|
PrePublish |
Called by AdvantageCSP prior to publishing the object.
|
|
|
PreSaveDraft |
Called by AdvantageCSP prior to saving a draft of the object.
|
|
|
PreUnpublish |
Called by AdvantageCSP prior to un-publishing the object.
|
|
|
RemoveEmptyNodes |
Recursively removes child elements that have no content, no attributes, and no
sub-elements. Leaves node itself in place.
|
|
|
SetSearchableProperties()()()() |
Sets the searchable properties.
|
|
|
SetSearchableProperties(ActionArgs) |
Overridable method to set the searchable properties when action context is required.
|
|
|
SetSummaryDataRow()()()() |
Sets the summary data row.
|
|
|
SetSummaryDataRow(ActionArgs) |
Overridable method to set the summary data row when action context is required.
|
|
|
StripIgnoredNodes |
Removes framework-owned elements (MasterID, Version, PublishStatus, audit fields,
etc.) from root so the remaining tree reflects only the
business-meaningful state for comparison/diff purposes.
|
|
|
Validate |
Validates the object for the specified action. Override to add custom validation logic.
|
Properties
| Name | Description | |
|---|---|---|
|
CreatedBy |
User object was created by
|
|
|
CreatedDate |
Date object was created
|
|
|
LanguageID |
Language Id of object
|
|
|
LastModifiedBy |
User who last modified the object
|
|
|
LastModifiedDate |
Last modified date of object
|
|
|
MasterID |
Unique Identifier of object
|
|
|
ObjectTypeName |
String name of object used by AdvantageCMS. Maps to "Object Name" in Data Tools.
|
|
|
PublishStatus |
Status of object (Publish, Draft, Historical)
|
|
|
RestrictToCurrentDomain |
True -> Object data cannot be published to multiple sites.
|
|
|
SEOContent |
SEO Content that can be used in page meta data (if applicable).
|
|
|
SEOKeywords |
SEO Keywords that can be used in page meta data (if applicable).
|
|
|
SEOName |
SEOName that can be used to generate the object url (if applicable).
|
|
|
Version |
Version of object
|
|
|
VersionName |
Version name for user reference
|