Consultingwerk.SmartFramework.Repository.Object.ObjectMasterBusinessEntity

Namespace:

Consultingwerk.SmartFramework.Repository.Object

Class

ObjectMasterBusinessEntity

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.BusinessEntity

Consultingwerk.SmartFramework.SmartBusinessEntity

Consultingwerk.SmartFramework.Repository.Object.ObjectMasterBusinessEntity

Inherits:

Consultingwerk.SmartFramework.SmartBusinessEntity

Implements:

Ccs.BusinessLogic.IBusinessEntity, Ccs.BusinessLogic.IUpdatableBusinessEntity, Consultingwerk.OERA.IBusinessEntity, Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.IFetchDataByReference, Consultingwerk.OERA.IHasContextID, IProvidesBusinessEntityDescriptor, Consultingwerk.OERA.IProvidesDatasetModel, Consultingwerk.OERA.RestResource.ISupportsETagValue, Consultingwerk.OERA.ISupportsResetState, Consultingwerk.OERA.RestResource.ISupportsRestAddress, Consultingwerk.OERA.RestResource.ISupportsRestMethods, Consultingwerk.OERA.ISupportsStaticQueryRequests

Consultingwerk.SmartFramework.Repository.Object.ObjectMasterBusinessEntity

Top Method Summary

Options	Name	Purpose
	AddInheritedRecordError (handle, integer, character)	Adds the validation error for a modified or deleted page, instance or link of the base object master to the merged design-time view of a customized variant
	LOGICAL CanFindInstance (character, character)	Returns if an instance with the given name exists in the given container
	LOGICAL CanFindPage (character, integer, character)	Returns if a page with the given page number or page key exists in the given container
F	FetchData (IFetchDataRequest, dataset)	Fetch data from the Data Access object
	FetchDataByKeyTable (dataset, IFetchDataByKeyTableParameter)	Supports to retrieve multiple DB records from a Business Entity based on a temp-table with key values
	FetchDataByKeyTable2 (dataset, IFetchDataByKeyTableParameter)	Allows retrieve multiple DB records from a Business Entity based on a temp-table with key values
F	FetchDataByReference (IFetchDataRequest, dataset)	Fetch data from the Data Access object
	FetchObjectMaster (dataset, character)	Fetches an ObjectMaster by guid or name Notes : First tries to fetch by ObjectMasterGuid. When no record is returned, falls back to fetching by ObjectName. @param dsObjectMaster INPUT-OUTPUT DATASET-HANDLE for the response dataset @param pcValue The guid or name value */
	FetchObjectMaster (dataset, CharacterHolder)	Fetches an ObjectMaster by guid or name using a CharacterHolder value. @param dsObjectMaster INPUT-OUTPUT DATASET-HANDLE for the response dataset @param poValue The CharacterHolder containing the guid or name */
	FetchObjectMasterWithAttributeValues (dataset, FindObjectMasterWithAttributeValuesParameter)	Returns a dataset with Object Master records that have the given attribute values
	Consultingwerk.CharacterHolder GetBaseObjectMasterGuid (CharacterHolder)	Returns the ObjectMasterGuid of the base object master of a customized variant
	CHARACTER GetContainerGuidFromQuery (character)	Returns the ContainerObjectMasterGuid a query string filters on
	Consultingwerk.CharacterHolder GetCustomizedObjectMasterGuid (GetCustomizedObjectMasterGuidParameter)	Returns the ObjectMasterGuid of the customized variant of a base object master that applies to a list of customization result codes
	LOGICAL GetInstanceHasChildren (character, character)	Returns if the object instance has nested children
	Consultingwerk.SmartFramework.Repository.Object.ObjectInstanceDetails GetObjectInstanceDetails (character)	Returns an ObjectInstanceDetails instance with the details about the object instance provided by it's guid
	Consultingwerk.CharacterHolder GetObjectMasterCustomizationResultCode (CharacterHolder)	Returns the customization result code of an object master
	Consultingwerk.CharacterHolder GetObjectMasterGuidFromInstanceGuid (CharacterHolder)	Returns the Object Master Guid based on an Object Instance GUID
	Consultingwerk.CharacterHolder GetObjectMasterGuidFromObjectName (CharacterHolder)	Returns the ObjectMasterGuid from on ObjectName
	CHARACTER GetRequestQuery (IFetchDataRequest, character)	Returns the query string of a table of a FetchData request
	Consultingwerk.OERA.IFetchDataByStaticQueryRequest GetStaticQueryRequest (character, character, character, character)	Returns a strong-typed static query request instance for the given table and field combination
	LOGICAL HasCustomizedVariants (character, character)	Returns if customized variants of the object master with the given name exist
	InvokeReceiveData (RequestTypeEnum, Object)	Invokes the ReceiveData method
	MergeBaseObjectMaster (IFetchDataRequest, character, character)	Merges the pages, instances and links of a base object master into the rows of its customized variant
	MergeBaseObjectMasters (IFetchDataRequest)	Merges the pages, instances and links of the base object masters into the customized variants returned by a FetchData request
	MergeBaseRecord (character, handle, character)	Adds a page, an instance or a link of the base object master to the rows of its customized variant
	MovePage (dataset, MovePageParameter)	Moves a page in a container
	NotifyCascadedChanges ()	Raises the ObjectMasterChanged event of the ISmartRepositoryService for the customized variants that the DataAccess modified through cascaded renames
	ObjectIsA (dataset, ObjectIsAParameter)	Returns if the object master is a child of the given class
	CHARACTER ObjectMasterTypeName (character)	Returns the ObjectTypeName of the provided container
	ReceiveData ()	Provides a hook to modify data in the ProDataset after Read and Update operations (i.e. population of aggregated values)
	RegisterCustomizedObjectInstance (dataset, RegisterCustomizedObjectInstanceParameter)	Registers the customized (shadow) object instance of an instance of a base object master in a customized variant of that object master
	RegisterMergedContainer (character)	Registers a container of the current FetchData request for the merge with its base object master
	RemoveCustomizedObjectInstance (dataset, RemoveCustomizedObjectInstanceParameter)	Removes the customization of an object instance from a customized variant
	RemoveUnusedCustomizedObjectInstance (dataset, RemoveCustomizedObjectInstanceParameter)	Removes a customized (shadow) instance of a customized variant that does no longer override attribute values of its base instance
	RenameCustomizedObjectInstances (dataset, RenameCustomizedObjectInstancesParameter)	Renames the customized (shadow) instances of an instance of a base object master in all customized variants of that object master
	ReplaceObjectInstance (character, ReplaceObjectInstanceParameter)	Replaces an Object instance with a new object master
	ResolveContainerCustomization (character)	Resolves the base / customized variant topology of a container into the ttContainerCustomization and ttCustomizedVariant temp-tables
	SaveChanges ()	Saves changes using the DataAccess object
	SaveChanges (IActionType)	Saves changes with an Action Type instance
	ValidateCustomizedObjectMaster (buffer)	Validates that a customized variant of an object master has a base object master of the same name and the same object type
	ValidateData ()	Provides a hook for high level data validation before Update operations
	ValidateInstanceNameAcrossVariants (buffer, character)	Validates that the name of a new or renamed instance does not collide with the instances of the base object master or of its customized variants
	ValidateInstanceOnSamePageAsParent (buffer)	Validates that an instance is on the same page as it's parent object instance
	ValidatePageUniqueAcrossVariants (buffer)	Validates that the page number and the page key of a new or changed page are unique across the base object master and its customized variants
	ValidateSupportedInstanceType (buffer)	Validates that the instance type is supported in the parent

Top Constructor Summary

	Options	Name	Purpose
		ObjectMasterBusinessEntity ()	Constructor of the ObjectMasterBusinessEntity class

Top Property Summary

	Options	Name	Purpose
		Consultingwerk.SmartFramework.Repository.Object.ChangeObjectTypeActionType ChangeObjectTypeActionType
		CHARACTER MergeBaseObjectMasterContext

Method Detail

Top

AddInheritedRecordError (handle, integer, character)

Purpose:	Adds the validation error for a modified or deleted page, instance
	or link of the base object master to the merged design-time view of
	a customized variant
Notes:	SCL-5907, SCL-5908, SCL-5910: The error is added to the after row
	of a modified row and to the before row of a deleted row

Parameters:
phBeforeBuffer	HANDLE
	The handle of the before buffer positioned on the row
piMessageNumber	INTEGER
	The SFR message number (58 page, 59 instance, 60 link)
pcRecordName	CHARACTER
	The name or number of the page, instance or link for the message

Top

LOGICAL CanFindInstance (character, character)

Purpose:	Returns if an instance with the given name exists in the given container
Notes:	SCL-5899

Parameters:
pcContainerObjectMasterGuid	CHARACTER
	The ObjectMasterGuid of the container
pcInstanceName	CHARACTER
	The instance name to look for
Returns	LOGICAL
	Logical value indicating if an instance with the name exists in the container

Top

LOGICAL CanFindPage (character, integer, character)

Purpose:	Returns if a page with the given page number or page key exists in
	the given container
Notes:	SCL-5899

Parameters:
pcContainerObjectMasterGuid	CHARACTER
	The ObjectMasterGuid of the container
piPageSequence	INTEGER
	The page number to look for, ? to look for the page key only
pcPageKey	CHARACTER
	The page key to look for, ? to look for the page number only
Returns	LOGICAL
	Logical value indicating if a page with the page number or page key exists

Top

FetchData (IFetchDataRequest, dataset)

Purpose:	Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest	Consultingwerk.OERA.IFetchDataRequest
	The IFetchDataRequest object with the parameters for this call
dsObjectMaster	DATASET dsObjectMaster

Top

FetchDataByKeyTable (dataset, IFetchDataByKeyTableParameter)

Purpose:	Supports to retrieve multiple DB records from a Business Entity based on
	a temp-table with key values
Notes:

Parameters:
dsObjectMaster	DATASET dsObjectMaster

poParameter	Consultingwerk.OERA.IFetchDataByKeyTableParameter
	The IFetchDataByKeyTableParameter with the data for this call

Top

FetchDataByKeyTable2 (dataset, IFetchDataByKeyTableParameter)

Purpose:	Allows retrieve multiple DB records from a Business Entity based on
	a temp-table with key values
Notes:

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	OUTPUT DATASET
poParameter	Consultingwerk.OERA.IFetchDataByKeyTableParameter
	The IFetchDataByKeyTableParameter with the data for this call

Top

FetchDataByReference (IFetchDataRequest, dataset)

Purpose:	Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest	Consultingwerk.OERA.IFetchDataRequest
	The IFetchDataRequest object with the parameters for this call
dsObjectMaster	DATASET dsObjectMaster

Top

FetchObjectMaster (dataset, character)

Purpose:	Fetches an ObjectMaster by guid or name
	Notes : First tries to fetch by ObjectMasterGuid. When no record is returned,
	falls back to fetching by ObjectName.

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET-HANDLE for the response dataset
pcValue	CHARACTER
	The guid or name value

Top

FetchObjectMaster (dataset, CharacterHolder)

Purpose: Fetches an ObjectMaster by guid or name using a CharacterHolder value.

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET-HANDLE for the response dataset
poValue	Consultingwerk.CharacterHolder
	The CharacterHolder containing the guid or name

Top

FetchObjectMasterWithAttributeValues (dataset, FindObjectMasterWithAttributeValuesParameter)

Purpose:	Returns a dataset with Object Master records that have the given attribute values
Notes:

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	The Dataset with the response
poAttributes	Consultingwerk.SmartFramework.Repository.Object.FindObjectMasterWithAttributeValuesParameter
	The FindObjectMasterWithAttributeValuesParameter instance with the data with this call

Top

Consultingwerk.CharacterHolder GetBaseObjectMasterGuid (CharacterHolder)

Purpose:	Returns the ObjectMasterGuid of the base object master of a
	customized variant
Notes:	SCL-5900: Returns the unknown value when the object master is the
	base object master itself or has no base

Parameters:
poGuid	Consultingwerk.CharacterHolder
	The CharacterHolder with the ObjectMasterGuid of the customized variant
Returns	Consultingwerk.CharacterHolder
	The CharacterHolder with the ObjectMasterGuid of the base object master or ?

Top

CHARACTER GetContainerGuidFromQuery (character)

Purpose:	Returns the ContainerObjectMasterGuid a query string filters on
Notes:	SCL-5907: Returns the quoted value (single or double quotes) that
	follows the first reference to the ContainerObjectMasterGuid field
	of the query, the unknown value when the query does not filter on
	the ContainerObjectMasterGuid

Parameters:
pcQueryString	CHARACTER
	The query string
Returns	CHARACTER
	The ContainerObjectMasterGuid or ?

Top

Consultingwerk.CharacterHolder GetCustomizedObjectMasterGuid (GetCustomizedObjectMasterGuidParameter)

Purpose:	Returns the ObjectMasterGuid of the customized variant of a base
	object master that applies to a list of customization result codes
Notes:	SCL-5900: The first customization result code of the list for
	which a customized variant exists wins. The ObjectMasterGuid of the
	variant is returned in the CustomizedObjectMasterGuid property of
	the parameter, the unknown value when no variant applies

Parameters:
poParameter	Consultingwerk.SmartFramework.Repository.Object.GetCustomizedObjectMasterGuidParameter
	The GetCustomizedObjectMasterGuidParameter with the base object master and the customization result codes
Returns	Consultingwerk.CharacterHolder
	The CharacterHolder with the ObjectMasterGuid of the customized variant or ?

Top

LOGICAL GetInstanceHasChildren (character, character)

Purpose:	Returns if the object instance has nested children
Notes:

Parameters:
pcContainerObjectMasterGuid	CHARACTER

pcObjectInstanceGuid	CHARACTER

Returns	LOGICAL
	Logical value indicating if the instance has nested children

Top

Consultingwerk.SmartFramework.Repository.Object.ObjectInstanceDetails GetObjectInstanceDetails (character)

Purpose:	Returns an ObjectInstanceDetails instance with the details about the
	object instance provided by it's guid
Notes:

Parameters:
pcObjectInstanceGuid	CHARACTER
	The guid of the object instance to return details from
Returns	Consultingwerk.SmartFramework.Repository.Object.ObjectInstanceDetails
	The ObjectInstanceDetails structure with the details about the object instance

Top

Consultingwerk.CharacterHolder GetObjectMasterCustomizationResultCode (CharacterHolder)

Purpose:	Returns the customization result code of an object master
Notes:	SCL-5900: Returns an empty string for a base object master, the
	unknown value when the object master does not exist

Parameters:
poGuid	Consultingwerk.CharacterHolder
	The CharacterHolder with the ObjectMasterGuid of the object master
Returns	Consultingwerk.CharacterHolder
	The CharacterHolder with the customization result code of the object master

Top

Consultingwerk.CharacterHolder GetObjectMasterGuidFromInstanceGuid (CharacterHolder)

Purpose:	Returns the Object Master Guid based on an Object Instance GUID
Notes:

Parameters:
poInstanceGuid	Consultingwerk.CharacterHolder
	The Object Instance Guid
Returns	Consultingwerk.CharacterHolder
	The CharacterHolder with the Object Master GUID Value

Top

Consultingwerk.CharacterHolder GetObjectMasterGuidFromObjectName (CharacterHolder)

Purpose:	Returns the ObjectMasterGuid from on ObjectName
Notes:

Parameters:
poGuid	Consultingwerk.CharacterHolder
	The Character Holder with the Object Name value
Returns	Consultingwerk.CharacterHolder
	The CharacterHolder with the Object Master GUID Value

Top

CHARACTER GetRequestQuery (IFetchDataRequest, character)

Purpose:	Returns the query string of a table of a FetchData request
Notes:	SCL-5907: The queries of a request are a chr(1) delimited list that
	corresponds to the requested tables

Parameters:
poRequest	Consultingwerk.OERA.IFetchDataRequest
	The IFetchDataRequest
pcTableName	CHARACTER
	The name of the table
Returns	CHARACTER
	The query string of the table, an empty string when the request has no query for the table

Top

Consultingwerk.OERA.IFetchDataByStaticQueryRequest GetStaticQueryRequest (character, character, character, character)

Purpose:	Returns a strong-typed static query request instance for the
	given table and field combination
Notes:	Returns the unknown value when no static query covers the
	given table / field combination

Parameters:
pcTableName	CHARACTER
	The name of the (temp-)table the request is for
pcFieldNames	CHARACTER
	Comma-separated list of temp-table field names
pcFieldValues	CHARACTER
	CHR(1)-separated list of field values, positionally matching pcFieldNames
pcChildTables	CHARACTER
	Comma-separated list of child table names to be filled
Returns	Consultingwerk.OERA.IFetchDataByStaticQueryRequest
	The IFetchDataByStaticQueryRequest instance or the unknown value

Top

LOGICAL HasCustomizedVariants (character, character)

Purpose:	Returns if customized variants of the object master with the given
	name exist
Notes:	SCL-5899

Parameters:
pcObjectName	CHARACTER
	The ObjectName of the base object master
pcExcludedObjectMasterGuids	CHARACTER
	The comma-delimited list of the ObjectMasterGuids of the variants that do not count (deleted in the same request)
Returns	LOGICAL
	Logical value indicating if customized variants exist

Top

InvokeReceiveData (RequestTypeEnum, Object)

Purpose:	Invokes the ReceiveData method
Notes:	SCL-5907: After the calculated fields have been populated, the pages,
	instances and links of the base object masters are merged into the
	customized variants returned by a FetchData request whose
	CustomContext contains the MergeBaseObjectMasterContext entry

Parameters:
poRequestType	Consultingwerk.OERA.Enum.RequestTypeEnum
	The RequestTypeEnum describing the type of the current call
poRequest	Progress.Lang.Object
	The request argument, IFetchDataRequest, IFetchDataByKeyTableRequest or the parameter argument passed to the SaveChanges methods

Top

MergeBaseObjectMaster (IFetchDataRequest, character, character)

Purpose:	Merges the pages, instances and links of a base object master into
	the rows of its customized variant
Notes:	SCL-5907, SCL-5908, SCL-5910: Only the tables the request has
	fetched (listed in Tables, or all tables for "*") are merged. A
	table with a query of its own is merged with the same query
	addressed to the base object master (the variant GUID replaced by
	the base GUID) - a query that does not filter on the variant
	cannot be redirected and is skipped. Tables filled through the
	dataset relation of the object master are merged completely. The
	rows of the base are fetched through a dedicated Business Entity
	instance, so that their calculated fields are populated

Parameters:
poRequest	Consultingwerk.OERA.IFetchDataRequest
	The IFetchDataRequest of the current FetchData call
pcContainerObjectMasterGuid	CHARACTER
	The ObjectMasterGuid of the customized variant
pcBaseObjectMasterGuid	CHARACTER
	The ObjectMasterGuid of the base object master

Top

MergeBaseObjectMasters (IFetchDataRequest)

Purpose:	Merges the pages, instances and links of the base object masters
	into the customized variants returned by a FetchData request
Notes:	SCL-5907, SCL-5908, SCL-5910: The variants are taken from the
	eSmartObjectMaster rows, from the containers of the fetched pages,
	instances and links and from the ContainerObjectMasterGuid the
	queries of the request filter on (a variant without pages of its
	own returns no rows to take the container from). The merge runs
	with change tracking disabled, the merged rows are unmodified rows
	of the dataset

Parameters:
poRequest	Consultingwerk.OERA.IFetchDataRequest
	The IFetchDataRequest of the current FetchData call

Top

MergeBaseRecord (character, handle, character)

Purpose:	Adds a page, an instance or a link of the base object master to the
	rows of its customized variant
Notes:	SCL-5907, SCL-5908, SCL-5910: The merged row carries the
	ContainerObjectMasterGuid of the variant and is marked with
	InheritedFromBase. A base instance that the variant has customized
	(an instance of the variant with the same InstanceName - the
	customized shadow instance) replaces the customized instance in
	the merged view: the base instance is marked as Customized and
	carries the ObjectInstanceGuid of the customized instance. Rows
	that are part of the dataset already, and rows that collide with a
	unique index of the variant (reported by the repository integrity
	check), are not merged

Parameters:
pcTableName	CHARACTER
	The name of the temp-table
phSource	HANDLE
	The handle of the buffer with the row of the base object master
pcContainerObjectMasterGuid	CHARACTER
	The ObjectMasterGuid of the customized variant

Top

MovePage (dataset, MovePageParameter)

Purpose:	Moves a page in a container
Notes:

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET
poParameter	Consultingwerk.SmartFramework.Repository.Object.MovePageParameter
	The Parameter Object for this method

Top

NotifyCascadedChanges ()

Purpose:	Raises the ObjectMasterChanged event of the ISmartRepositoryService
	for the customized variants that the DataAccess modified through
	cascaded renames
Notes:	SCL-5899: Renaming a base object master renames its customized
	variants, renaming an instance of a base object master renames the
	customized instances in all variants. Those object masters are not
	part of the dataset, so NotifyChanges does not cover them

Top

ObjectIsA (dataset, ObjectIsAParameter)

Purpose:	Returns if the object master is a child of the given class
Notes:

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET
poParameter	Consultingwerk.SmartFramework.Repository.Object.ObjectIsAParameter
	The Parameter Object for this method

Top

CHARACTER ObjectMasterTypeName (character)

Purpose:	Returns the ObjectTypeName of the provided container
Notes:

Parameters:
pcContainerObjectMasterGuid	CHARACTER
	The object master guid of the container
Returns	CHARACTER
	The object type name

Top

ReceiveData ()

Purpose:	Provides a hook to modify data in the ProDataset after Read and
	Update operations (i.e. population of aggregated values)
Notes:	Invoked during FetchData () and SaveChanges ()

Top

RegisterCustomizedObjectInstance (dataset, RegisterCustomizedObjectInstanceParameter)

Purpose:	Registers the customized (shadow) object instance of an instance of
	a base object master in a customized variant of that object master
Notes:	SCL-5899: The attribute values that a customized variant overrides on
	an instance of the base object master are stored on a customized
	instance in the variant container, as SmartAttributeValue is unique on
	ObjectTypeGuid, ObjectMasterGuid, ObjectInstanceGuid and AttributeLabel.
	The customized instance is matched to its base instance by name: it
	carries the InstanceName of the base instance, ObjectMasterGuid,
	PageGuid, ParentInstanceGuid and ObjectSequence are copied from the
	base instance and are ignored when base and variant are merged.
	Returns the ObjectInstanceGuid of an already registered customized
	instance, so that the method can be called repeatedly.
	Should only be called from the framework (attribute value editing of
	customized variants), a customized instance is never created through
	the ordinary SaveChanges of a variant container

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET
poParameter	Consultingwerk.SmartFramework.Repository.Object.RegisterCustomizedObjectInstanceParameter
	The RegisterCustomizedObjectInstanceParameter with the customized variant and the base instance, receives the ObjectInstanceGuid of the customized instance

Top

RegisterMergedContainer (character)

Purpose:	Registers a container of the current FetchData request for the
	merge with its base object master
Notes:	SCL-5907: Every container is looked up once. A container that is
	not a customized variant (or that has no base object master) is
	registered with an unknown BaseObjectMasterGuid and is not merged

Parameters:
pcContainerObjectMasterGuid	CHARACTER
	The ObjectMasterGuid of the container

Top

RemoveCustomizedObjectInstance (dataset, RemoveCustomizedObjectInstanceParameter)

Purpose:	Removes the customization of an object instance from a customized
	variant
Notes:	SCL-5909: For an instance of the base object master the customized
	(shadow) instance of the variant is deleted together with its
	attribute values (the referential integrity of the repository
	removes the SmartAttributeValue records of a deleted instance), so
	the base instance applies unchanged again. The instance may be
	addressed by the ObjectInstanceGuid of the base instance or of the
	customized instance. An instance added by the variant itself is
	deleted. The Removed property of the parameter receives whether an
	instance was removed - nothing is removed when the variant has not
	customized the base instance

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET
poParameter	Consultingwerk.SmartFramework.Repository.Object.RemoveCustomizedObjectInstanceParameter
	The RemoveCustomizedObjectInstanceParameter with the customized variant and the instance

Top

RemoveUnusedCustomizedObjectInstance (dataset, RemoveCustomizedObjectInstanceParameter)

Purpose:	Removes a customized (shadow) instance of a customized variant that
	does no longer override attribute values of its base instance
Notes:	SCL-5912 (moved here from the SmartRepositoryService, SCL-5904):
	Removing the last override of a base instance removes the
	customized instance again. The instance is kept while it still
	holds attribute values or while links or child instances of the
	variant refer to it (customized instances registered before
	SCL-5904 may be referenced directly). Nothing happens when the
	instance does not belong to the variant or is not the customized
	instance of a base instance (an addition of the variant).
	The Removed property of the parameter receives whether the
	instance was removed

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET
poParameter	Consultingwerk.SmartFramework.Repository.Object.RemoveCustomizedObjectInstanceParameter
	The RemoveCustomizedObjectInstanceParameter with the customized variant and the customized instance

Top

RenameCustomizedObjectInstances (dataset, RenameCustomizedObjectInstancesParameter)

Purpose:	Renames the customized (shadow) instances of an instance of a base
	object master in all customized variants of that object master
Notes:	SCL-5899: Renaming an instance of a base object master through
	SaveChanges cascades to the customized instances automatically.
	This method serves the RepositoryObjectImporter, which imports an
	instance rename in two steps (the instance names of the existing
	rows are cleared first) and therefore cascades the rename itself.
	Raises the ObjectMasterChanged event for every modified variant

Parameters:
dsObjectMaster	DATASET dsObjectMaster
	INPUT-OUTPUT DATASET
poParameter	Consultingwerk.SmartFramework.Repository.Object.RenameCustomizedObjectInstancesParameter
	The RenameCustomizedObjectInstancesParameter with the base object master and the previous and the new instance name

Top

ReplaceObjectInstance (character, ReplaceObjectInstanceParameter)

Purpose:	Replaces an Object instance with a new object master
Notes:	Should only be called from the SmartRepositoryBusinessTask for transaction
	coordination with the SmartAttributeValueBusinessEntity

Parameters:
pcContainerObjectMasterGuid	CHARACTER
	The GUID of the Container SmartObjectMaster
poParameter	Consultingwerk.SmartFramework.Repository.ReplaceObjectInstanceParameter
	The ReplaceObjectInstanceParameter instance with the data for this call

Top

ResolveContainerCustomization (character)

Purpose:	Resolves the base / customized variant topology of a container
	into the ttContainerCustomization and ttCustomizedVariant temp-tables
Notes:	SCL-5899: A customized variant shares the ObjectName of its base
	object master (CustomizationResultGuid = "") and differs in the
	CustomizationResultGuid. A container created in the same request
	is taken from the dataset. Nothing is resolved for an unknown container

Parameters:
pcContainerObjectMasterGuid	CHARACTER
	The ObjectMasterGuid of the container

Top

SaveChanges ()

Purpose:	Saves changes using the DataAccess object
Notes:	SCL-5821: Raises the ObjectMasterChanged event of the
	ISmartRepositoryService for every Object Master affected by
	the saved changes

Top

SaveChanges (IActionType)

Purpose:	Saves changes with an Action Type instance
Notes:	SCL-5821: Raises the ObjectMasterChanged event of the
	ISmartRepositoryService for every Object Master affected by
	the saved changes

Parameters:
poActionType	Consultingwerk.OERA.IActionType
	The Action Type instance

Top

ValidateCustomizedObjectMaster (buffer)

Purpose:	Validates that a customized variant of an object master has a base
	object master of the same name and the same object type
Notes:	SCL-5899: The base may be created in the same request

Parameters:
b_eSmartObjectMaster	buffer
	The buffer to validate

Top

ValidateData ()

Purpose:	Provides a hook for high level data validation before Update
	operations
Notes:	Invoked during SaveChanges (). When the ERROR flag of the ProDataset
	is set, the Update operation will be cancelled before writing back
	the data to the database using the DataAccess object

Top

ValidateInstanceNameAcrossVariants (buffer, character)

Purpose:	Validates that the name of a new or renamed instance does not collide
	with the instances of the base object master or of its customized
	variants
Notes:	SCL-5899: An instance of a customized variant whose name exists in the
	base container is the customized (shadow) instance of that base
	instance. Such an instance is only created through
	RegisterCustomizedObjectInstance and cannot be renamed, a new
	instance of a variant must not use a name of the base and a new
	or renamed instance of the base must not use a name that one of
	the variants added

Parameters:
b_eSmartObjectInstance	buffer
	The buffer to validate
pcPreviousInstanceName	CHARACTER
	The previous name of a renamed instance, ? for a new instance

Top

ValidateInstanceOnSamePageAsParent (buffer)

Purpose:	Validates that an instance is on the same page as it's parent object instance
Notes:

Parameters:
b_eSmartObjectInstance	buffer
	The buffer to validate

Top

ValidatePageUniqueAcrossVariants (buffer)

Purpose:	Validates that the page number and the page key of a new or changed
	page are unique across the base object master and its customized
	variants
Notes:	SCL-5899: The pages of the base and of a variant are merged by
	PageSequence at runtime

Parameters:
b_eSmartPage	buffer
	The buffer to validate

Top

ValidateSupportedInstanceType (buffer)

Purpose:	Validates that the instance type is supported in the parent
Notes:

Parameters:
b_eSmartObjectInstance	buffer
	The buffer to validate

Constructor Detail

Top

ObjectMasterBusinessEntity ()

Purpose:	Constructor of the ObjectMasterBusinessEntity class
Notes:	Passes the handle of the dataset instance to the base class and
	sets the default DataAccessName