Namespace: Consultingwerk.SmartFramework.Repository
Class 
SmartRepositoryService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.Repository.SmartRepositoryClientService
Consultingwerk.SmartFramework.Repository.SmartRepositoryService

Inherits: Consultingwerk.SmartFramework.Repository.SmartRepositoryClientService
Implements: Ccs.Common.IService, Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService, Consultingwerk.SmartFramework.Repository.ISmartRepositoryService

/*&GLOBAL-DEFINE NoUserLobStatistics NoUserLobStatistics

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AssignContainerObjectMaster (handle, handle) Makes the customized variant the object master of the merged repository data of a container
CHARACTER BuildPagesFilterString (handle, integer[]) Builds a query string for the list of pages
CacheAttribute (character) Caches the attribute data
CHARACTER ChangeObjectType (character, character) Changes the object type of the given Object Master
ClearCaches () Clears all caches of this class
CHARACTER CopyObjectMaster (CopyObjectMasterParameter) Creates a copy of the given object master
CHARACTER CreateCustomizedObjectMaster (character, character, character, character) Creates a customized variant of an object master for a customization result code
Consultingwerk.Framework.Collections.CharacterList CreateDataFields (handle, character, IOverwritePromptCallback) Creates MetaEntityTable, MetaDataField and MetaCalculatedField object masters for the given Business Entity Model
Consultingwerk.Framework.Collections.CharacterList CreateDataFields (handle, character, IOverwritePromptCallback, character, character, character) Creates MetaEntityTable, MetaDataField and MetaCalculatedField object masters for the given Business Entity Model
CHARACTER CreateInstance (character, character, character, character, character, character, integer, character, character, DictionaryAttributeValue) Creates an Object Instance in the customized variant of a Container
CHARACTER CreateInstance (character, character, character, character, character, integer) Creates an Object Instance
CHARACTER CreateInstance (character, character, character, character, character, integer, character, character, DictionaryAttributeValue) Creates an Object Instance
CHARACTER CreateInstance (character, character, character, character, character, integer, character, DictionaryAttributeValue) Creates an Object Instance
CHARACTER CreateInstance (character, character, character, character, character, integer, DictionaryAttributeValue) Creates an Object Instance
CHARACTER CreateInstance (character, character, character, character, integer, integer) Creates an Object Instance
CHARACTER CreateLink (character, character, character, character) Creates a SmartLink between two instances or the container
CHARACTER CreateLink (character, character, character, character, character) Creates a SmartLink in the customized variant of a container
CHARACTER CreateObjectMaster (character, character, character, character, character, DictionaryAttributeValue) Creates an Object Master
CHARACTER CreateObjectMaster (CreateObjectMasterParameter) Creates an Object Master
CHARACTER CreateObjectMasterFromInstance (CreateObjectMasterFromInstanceParameter) Creates a new Object Master based on an Object Instance
CHARACTER CreatePage (character, character, integer, character, character, character, character, character) Creates a Page in the customized variant of a Container
CHARACTER CreatePage (character, integer, character) Creates a Page in a Container
CHARACTER CreatePage (character, integer, character, character, character, character, character) Creates a Page in a Container
CustomizeRepositoryData (handle) Customizes the repository data
CHARACTER DeleteLink (character, character, character, character) Deletes a SmartLink between two instances or the container
CHARACTER DeleteLink (character, character, character, character, character) Deletes a SmartLink from the customized variant of a container
DeleteObjectInstance (character, character) Deletes an object instance from a container
DeleteObjectInstance (character, character, character) Deletes an object instance from the customized variant of a container
DeleteObjectMaster (character) Deletes a given object master
CHARACTER DeletePage (character, character, integer) Deletes a Page from the customized variant of a Container
CHARACTER DeletePage (character, integer) Deletes a Page from a Container
dispose () Disposes the service instance
CHARACTER DuplicateObjectInstance (DuplicateObjectInstanceParameter) Creates a duplicate of the given object instance
LOGICAL EnsureCustomizationResolution (character) Ensures that the customization topology of an object master is resolved in the ttCustomizationResolution temp-table
CHARACTER EnsureCustomizedObjectInstance (character, character) Ensures that the attribute values of an instance addressed through a customized variant can be stored in the variant
CHARACTER EnsureGuids (character) Ensures that the list of classes contains GUIDs and not class names
CHARACTER EnsureLinkTypeGuid (character) Ensures that the provided value is a Link Type Guid
CHARACTER EnsureModuleGuid (character) Ensures that the provided value is a Product Module Guid
EnsureObjectTypeCache () Ensures that the local object type cache is filled
HANDLE FetchRepositoryObject (FetchRepositoryObjectParameter) Fetches an object from the repository
HANDLE FetchRepositoryObject (IAnnotationBasedFormParameter) Fetches an annotation based form from the repository
CHARACTER FindCustomizedObjectInstance (character, character) Returns the ObjectInstanceGuid of the customized (shadow) instance that holds the attribute values of an instance addressed through a customized variant
Consultingwerk.SmartFramework.Repository.AttributeValue FindObjectInstanceAttributeValue (character, character, character) Returns the attribute value stored for an object instance
CHARACTER FindObjectInstanceGuid (character, character) Returns the Object Instance Guid of an instance of exactly the given container
Consultingwerk.SmartFramework.Repository.AttributeValue FindObjectMasterAttributeValue (character, character, character) Returns the attribute value stored for an object master
LOGICAL FindObjectMasterByName (ObjectMasterDatasetModel, character) Positions the ObjectMasterDatasetModel on the object master with the given object name
CHARACTER FindPageGuid (ObjectMasterDatasetModel, character, character) Returns the PageGuid of a page of exactly the given container
CHARACTER GetAttributeConstantLevel (character) Returns the constant level of the attribute
CHARACTER GetAttributeDataType (character) Returns the repository type based of the attribute
CHARACTER GetAttributeLabel (character) Returns the repository label of the attribute
CHARACTER GetAttributeTechnicalName (character) Returns the technical name of the attribute
Consultingwerk.SmartFramework.Repository.AttributeValue GetAttributeValue (SmartAttributeValueTableModel, character, character) Returns the AttributeValue for the SmartAttributeValue record the table model is positioned on
CHARACTER GetBaseObjectMasterGuid (character) Returns the ObjectMasterGuid of the base object master of a customized variant
CHARACTER GetChildClasses (character) Returns the comma delimited list of child class guids of the provided parent classes
CHARACTER GetChildClassesFromCache (character) Returns the child-class hierarchy (parents plus all descendants) of the given root class(es) resolved from the local object-type cache
CHARACTER GetCustomizedObjectMasterGuid (character, character) Returns the ObjectMasterGuid of the customized variant of a base object master that applies to a list of customization result codes
Consultingwerk.OERA.IDataSourceInfo GetDataSourceInfo (character) Returns the IDataSourceInfo based on a repository object (MetaDataSource)
CHARACTER GetDesignTimeDataSourceGuid (character) Returns the GUID of the DesignTimeDataSource of the given Object Master (GUID or Name) or Object Instance (GUID)
Consultingwerk.OERA.IDataSourceInfo GetDesignTimeDataSourceInfo (character) Returns the IDataSourceInfo based on a repository object's (MetaDataSource) Design time data source
CHARACTER GetEntityFieldMapping (character, character, character, character) Returns the name fo the field object used to render a given Business Entity Field
Consultingwerk.SmartFramework.Repository.ScreenMapping.ListScreenMapping GetEntityTableMapping (character, character, character) Returns the list of entity field mappings for the given Business EntityTable and UI Types
Progress.Json.ObjectModel.JsonObject GetJsonField (character, character, character, character, logical, logical, logical, handle, character) Renders a repository field as JSON
Progress.Json.ObjectModel.JsonObject GetJsonField (character, character, character, character, logical, logical, logical, handle, character, handle) Renders a repository field as JSON
Progress.Json.ObjectModel.JsonObject GetJsonField (handle, handle, character, character, character, logical, logical, logical, IBusinessEntityDescriptor, handle, character, LayoutStyleEnum) Renders a repository field as JSON
CHARACTER GetLinkTypeGuid (character) Returns the Link Type Guid based on a Link Type Name or a link type guid
INTEGER GetMaxObjectSequence (ObjectMasterDatasetModel, character) Returns the highest object sequence of the instances of a container
Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectInstanceAttributeValue (character, character) Returns a single Attribute Value assigned to an Object Instance
CHARACTER GetObjectInstanceGuid (character, character) Returns the Object Instance Guid based on an Container Object Master Name or guid and an Instance Name or guid
CHARACTER GetObjectInstanceGuid (character, character, logical) Returns the Object Instance Guid based on an Container Object Master Name or guid and an Instance Name or guid
Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectMasterAttributeValue (character, character) Returns a single Attribute Value assigned to an Object Master
Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectMasterAttributeValue (character, character, character) Returns a single Attribute Value assigned to an Object Master
CHARACTER GetObjectMasterCustomizationResultCode (character) Returns the customization result code of an object master
CHARACTER GetObjectMasterDescription (character) Returns the Object Master Description based on an Object Master Name or an object type guid
CHARACTER GetObjectMasterGuid (character) Returns the Object Master Guid based on an Object Master Name or an object master guid
CHARACTER GetObjectMasterGuid (character, character, logical) Returns the Object Master Guid of the customized variant of an object master for a customization result code
CHARACTER GetObjectMasterGuid (character, logical) Returns the Object Master Guid based on an Object Master Name or an object master guid
CHARACTER GetObjectMasterGuidFromInstanceGuid (character) Returns the Object Master Guid based on an Object Instance GUID
CHARACTER GetObjectMasterGuidFromInstanceGuid (character, logical) Returns the Object Master Guid based on an Object Instance GUID
CHARACTER GetObjectMasterName (character) Returns the Object Master Name based on an Object Master Name or an object type guid
CHARACTER GetObjectMasterName (character, logical) Returns the Object Master Name based on an Object Master Name or an object type guid
Consultingwerk.Framework.Collections.CharacterList GetObjectsWithAttributeValues (DictionaryAttributeValue) Returns a list of objects with the given attribute values
Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectTypeAttributeValue (character, character) Returns a single Attribute Value assigned to an Object Master
Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectTypeAttributeValue (character, character, character) Returns a single Attribute Value assigned to an Object Master
CHARACTER GetObjectTypeEvents (character) Returns the comma-delimited list of event names defined for an object type
CHARACTER GetObjectTypeFieldFromCache (character, character) Returns a field value of an object type resolved from the local object-type cache, or the unknown value when the type is not cached
CHARACTER GetObjectTypeGuid (character) Returns the Object Type Guid based on an Object Type Name or an object type guid
CHARACTER GetObjectTypeGuidOfMaster (character) Returns the Object Type Guid of the given object master
CHARACTER GetObjectTypeName (character) Returns the Object Type Name based on an Object Type Name or an object type guid
CHARACTER GetObjectTypeName (character, logical) Returns the Object Type Name based on an Object Type Name or an object type guid
CHARACTER GetParentClasses (character) Returns the CHR(1) delimited list of parent class guids of the provided child class
CHARACTER GetProductModuleDataFolder (character) Returns the Data Folder of the given Product Module
CHARACTER GetProductModuleGuid (character) Returns the Product Module Guid based on an Product Module Name or an product module guid
CHARACTER GetSessionCustomizationResultCodes () Returns the customization result codes of the current session
initialize () Initializes the service instance
InvalidateCustomizationCaches (ObjectMasterChangedEventArgs) Removes the entries of a changed object master and of the object masters of the same name (its base and its customized variants) from the resolution cache and their repository data from the ISmartRepositoryCache
LOGICAL IsLinkSupported (character, character, character) Verifies if the given link is valid
CHARACTER MapCustomizedInstanceGuid (handle, character) Maps the ObjectInstanceGuid of a customized (shadow) instance to the ObjectInstanceGuid of its base instance
CHARACTER MapCustomizedInstanceToBase (character, character) Returns the ObjectInstanceGuid of the base instance of a customized (shadow) instance of a customized variant
MergeCustomizedObjectMaster (handle, handle, handle) Merges the pages, object instances and links of a customized variant of a container into the repository data of the base container
MoveObjectInstance (character, character, character) Moves an object instance to another parent instance within the same container
MoveObjectInstance (character, character, character, character) Moves an object instance of the customized variant of a container to another parent instance
LOGICAL ObjectIsA (character, character) Returns if the object is of the given class
OnObjectMasterChanged (ObjectMasterChangedEventArgs) Raises the ObjectMasterChanged event
OnObjectMasterProductModuleChanged (ObjectMasterProductModuleChangedEventArgs) Raises the ObjectMasterProductModuleChanged event
RaiseObjectMasterChanged (ObjectMasterChangedEventArgs) Raises the ObjectMasterChanged event
RaiseObjectMasterProductModuleChanged (ObjectMasterProductModuleChangedEventArgs) Raises the ObjectMasterProductModuleChanged event
RemoveUnusedCustomizedObjectInstance (character, character) Removes a customized (shadow) instance of a customized variant that does no longer override attribute values of its base instance
ReplaceObjectInstance (character, character) Replaces an Object instance with a new object master
ReplaceObjectInstance (character, character, logical) Replaces an Object instance with a new object master
ResetDesignAttributes (character) Marks the given attributes as inherited in the dsDesignAttributeValues Dataset
ResetObjectInstanceAttributes (character, character, character) Resets the given Attributes of an Object Instance to their inherited values
ResetObjectInstanceAttributes (character, character, character, character) Resets the given Attributes of an Object Instance addressed through the customized variant of a container to their inherited values
ResetObjectMasterAttributes (character, character) Resets the given Attributes of an Object Master to their inherited values
ResetObjectMasterAttributes (character, character, character) Resets the given Attributes of the customized variant of an Object Master to their inherited values
ResolveCustomizedObjectMaster (character, character, character, character) Resolves the base object master and the customized variant of an object master that applies to a request
CHARACTER ResolvePageGuid (character, character) Resolves the PageGuid of a page of a container from a PageGuid or a page number
SetAbsolutePosition (JsonObject, handle) Updates a JSON Layout with absolute position
SetWebClassList (JsonObject, character) Updates a JSON Layout with the web style list of the viewer field
StoreObjectInstanceAttributes (character, character, character, DictionaryAttributeValue) Stores the given Attributes for an Object Instance addressed through the customized variant of a container
StoreObjectInstanceAttributes (character, character, DictionaryAttributeValue) Stores the given Attributes for an Object Instance
StoreObjectMasterAttributes (character, character, DictionaryAttributeValue) Stores the given Attributes for the customized variant of an Object Master
StoreObjectMasterAttributes (character, DictionaryAttributeValue) Stores the given Attributes for an Object Master
LOGICAL SupportsInstanceOfType (character, character) Returns if the Container supports instances of the given type
UpdateDesignAttributes (DictionaryAttributeValue) Updates the dsDesignAttributeValues Dataset based on the passed in Attributes Dictionary
CHARACTER UpdatePage (character, character, integer, character, character, character, character, character) Updates an existing Page of the customized variant of a Container
CHARACTER UpdatePage (character, integer, character, character, character, character, character) Updates an existing Page of a Container
ValidatePages (character, handle, integer[]) Validates the Pages parameter of the FetchRepositoryObject parameter
VerifyContainerSecurity (character) Verifies users access to the repository master
VerifyInstanceOwnedByContainer (character, character, character) Verifies that an object instance belongs to a container and not to the base object master of the container
VerifyPageNotInBase (character, integer) Verifies that a page does not belong to the base object master of a customized variant

Top Constructor Summary
Options Name Purpose
SmartRepositoryService () Constructor for the SmartRepositoryService class

Top Event Summary
Options Name Purpose
ObjectMasterChanged (Object, ObjectMasterChangedEventArgs) Event raised after an Object Master, or one of the pages, object instances or links of a container, has been saved
ObjectMasterProductModuleChanged (Object, ObjectMasterProductModuleChangedEventArgs) Event raised when the Product Module of an Object Master is changed


Method Detail
Top

AssignContainerObjectMaster (handle, handle)
Purpose: Makes the customized variant the object master of the merged
repository data of a container
Notes: SCL-5900: A customized variant addressed by its ObjectMasterGuid
keeps its identity: the eSmartObjectMaster record of the base is
replaced by the record of the variant and the pages, instances and
links of the merged container carry the ObjectMasterGuid of the
variant as ContainerObjectMasterGuid

Parameters:
phDataset HANDLE
The dataset with the merged repository data of the container
phVariantDataset HANDLE
The dataset with the repository data of the customized variant
Top

CHARACTER BuildPagesFilterString (handle, integer[])
Purpose: Builds a query string for the list of pages
Notes:

Parameters:
phPagesBuffer HANDLE
The handle of the eSmartPage buffer
piPages INTEGER
The Integer array with the list of pages
Returns CHARACTER
The query string for the list of pages
Top

CacheAttribute (character)
Purpose: Caches the attribute data
Notes:

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute
Top

CHARACTER ChangeObjectType (character, character)
Purpose: Changes the object type of the given Object Master
Notes:

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
pcNewObjectType CHARACTER
The Object Type Name or Object Type Guid to set on the Object Master
Returns CHARACTER
The GUID of the new object type
Top

ClearCaches ()
Purpose: Clears all caches of this class
Notes:

Top

CHARACTER CopyObjectMaster (CopyObjectMasterParameter)
Purpose: Creates a copy of the given object master
Notes: Does also create copies of the contained object instances and instance attributes

Parameters:
poCopyObjectMasterParameter Consultingwerk.SmartFramework.Repository.CopyObjectMasterParameter
The CopyObjectMasterParameter instance with the parameters for this method
Returns CHARACTER
The ObjectMasterGuid of the new object master
Top

CHARACTER CreateCustomizedObjectMaster (character, character, character, character)
Purpose: Creates a customized variant of an object master for a
customization result code
Notes: SCL-5904: The variant is an object master with the ObjectName and
the object type of the base object master (SCL-5899) and an empty
delta - no pages, instances, links or attribute values. The variant
lives in its own product module, the module of the base applies
when no module is provided

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid of the base object master (or of one of its variants)
pcCustomizationResultCode CHARACTER
The customization result code of the variant
pcProductModule CHARACTER
The name or GUID of the product module of the variant, empty for the module of the base object master
pcDescription CHARACTER
The description of the variant, empty for the description of the base object master
Returns CHARACTER
The Object Master Guid of the new customized variant
Top

Consultingwerk.Framework.Collections.CharacterList CreateDataFields (handle, character, IOverwritePromptCallback)
Purpose: Creates MetaEntityTable, MetaDataField and MetaCalculatedField
object masters for the given Business Entity Model
Notes: When the poOverwritePromptCallback reference is not valid, we'll
overwrite existing objects silently

Parameters:
phBusinessEntityDataset HANDLE
The ProDataset with the Business Entity Model to import
pcModuleName CHARACTER
The name of the Product Module to import the entity objects into
poOverwritePromptCallback Consultingwerk.SmartFramework.IOverwritePromptCallback
The callback reference to prompt the user if an existing object should be overwritten
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the GUID's of the created MetaEntityTable objects
Top

Consultingwerk.Framework.Collections.CharacterList CreateDataFields (handle, character, IOverwritePromptCallback, character, character, character)
Purpose: Creates MetaEntityTable, MetaDataField and MetaCalculatedField
object masters for the given Business Entity Model
Notes: When the poOverwritePromptCallback reference is not valid, we'll
overwrite existing objects silently

Parameters:
phBusinessEntityDataset HANDLE
The ProDataset with the Business Entity Model to import
pcModuleName CHARACTER
The name of the Product Module to import the entity objects into
poOverwritePromptCallback Consultingwerk.SmartFramework.IOverwritePromptCallback
The callback reference to prompt the user if an existing object should be overwritten
pcEntityTableType CHARACTER
The type to use for table objects
pcDataFieldType CHARACTER
The type to use for data field objects
pcCalculatedFieldType CHARACTER
The type to use for calculated field objects
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the GUID's of the created MetaEntityTable objects
Top

CHARACTER CreateInstance (character, character, character, character, character, character, integer, character, character, DictionaryAttributeValue)
Purpose: Creates an Object Instance in the customized variant of a Container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The instance may be placed on a page of the base
object master and below a parent instance of the base object
master. See CreateInstance

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcInstanceObject CHARACTER
The Object Master GUID or Object Name of the object to create an instance of
pcInstanceName CHARACTER
The name of the object instance (or ? to use the object name)
pcInstanceDescription CHARACTER
The description of the instance
pcPageGuid CHARACTER
The GUID or the sequence number of the page to create the instance on, leave empty for container page
piObjectSequence INTEGER
The sequence of the object instance on the given page
pcLayoutPosition CHARACTER
The layout position for the new instance
pcParentInstance CHARACTER
The Instance GUID or instance name of the parent instance (e.g. a group box), empty for top level
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The Dictionary of IAttributeValue instances
Returns CHARACTER
The Object Instance Guid
Top

CHARACTER CreateInstance (character, character, character, character, character, integer)
Purpose: Creates an Object Instance
Notes:

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcInstanceObject CHARACTER
The Object Master GUID or Object Name of the object to create an instance of
pcInstanceName CHARACTER
The name of the object instance (or ? to use the object name)
pcInstanceDescription CHARACTER
The description of the instance
pcPageGuid CHARACTER
The GUID or the sequence number of the page to create the instance on, leave empty for container page
piObjectSequence INTEGER
The sequence of the object instance on the given page
Returns CHARACTER
The Object Instance Guid
Top

CHARACTER CreateInstance (character, character, character, character, character, integer, character, character, DictionaryAttributeValue)
Purpose: Creates an Object Instance
Notes: An empty parent instance creates the instance at the top level of
the container or page. When a parent instance is provided and no
page is provided, the page of the parent instance is used. When
the object sequence is the unknown value or not positive, the
next free object sequence within the container is used

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcInstanceObject CHARACTER
The Object Master GUID or Object Name of the object to create an instance of
pcInstanceName CHARACTER
The name of the object instance (or ? to use the object name)
pcInstanceDescription CHARACTER
The description of the instance
pcPageGuid CHARACTER
The GUID or the sequence number of the page to create the instance on, leave empty for container page
piObjectSequence INTEGER
The sequence of the object instance on the given page
pcLayoutPosition CHARACTER
The layout position for the new instance
pcParentInstance CHARACTER
The Instance GUID or instance name of the parent instance (e.g. a group box), empty for top level
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The Dictionary of IAttributeValue instances
Returns CHARACTER
The Object Instance Guid
Top

CHARACTER CreateInstance (character, character, character, character, character, integer, character, DictionaryAttributeValue)
Purpose: Creates an Object Instance
Notes:

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcInstanceObject CHARACTER
The Object Master GUID or Object Name of the object to create an instance of
pcInstanceName CHARACTER
The name of the object instance (or ? to use the object name)
pcInstanceDescription CHARACTER
The description of the instance
pcPageGuid CHARACTER
The GUID or the sequence number of the page to create the instance on, leave empty for container page
piObjectSequence INTEGER
The sequence of the object instance on the given page
pcLayoutPosition CHARACTER
The layout position for the new instance
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The Dictionary of IAttributeValue instances
Returns CHARACTER
The Object Instance Guid
Top

CHARACTER CreateInstance (character, character, character, character, character, integer, DictionaryAttributeValue)
Purpose: Creates an Object Instance
Notes:

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcInstanceObject CHARACTER
The Object Master GUID or Object Name of the object to create an instance of
pcInstanceName CHARACTER
The name of the object instance (or ? to use the object name)
pcInstanceDescription CHARACTER
The description of the instance
pcPageGuid CHARACTER
The GUID or the sequence number of the page to create the instance on, leave empty for container page
piObjectSequence INTEGER
The sequence of the object instance on the given page
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The Dictionary of IAttributeValue instances
Returns CHARACTER
The Object Instance Guid
Top

CHARACTER CreateInstance (character, character, character, character, integer, integer)
Purpose: Creates an Object Instance
Notes:

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcInstanceObject CHARACTER
The Object Master GUID or Object Name of the object to create an instance of
pcInstanceName CHARACTER
The name of the object instance (or ? to use the object name)
pcInstanceDescription CHARACTER
The description of the instance
piPageSequence INTEGER
The sequence number of the page to create the instance on, zero for container page
piObjectSequence INTEGER
The sequence of the object instance on the given page
Returns CHARACTER
The Object Instance Guid
Top

CHARACTER CreateLink (character, character, character, character)
Purpose: Creates a SmartLink between two instances or the container
Notes: An empty source or target instance denotes the container itself.
Throws an error when the same link does already exist

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcSourceInstance CHARACTER
The Instance GUID or instance name of the link source, empty when the link source is the container
pcTargetInstance CHARACTER
The Instance GUID or instance name of the link target, empty when the link target is the container
pcLinkType CHARACTER
The link type GUID or link type name
Returns CHARACTER
The LinkGuid of the created Smart Link
Top

CHARACTER CreateLink (character, character, character, character, character)
Purpose: Creates a SmartLink in the customized variant of a container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The link may refer to instances of the base object
master. See CreateLink

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcSourceInstance CHARACTER
The Instance GUID or instance name of the link source, empty when the link source is the container
pcTargetInstance CHARACTER
The Instance GUID or instance name of the link target, empty when the link target is the container
pcLinkType CHARACTER
The link type GUID or link type name
Returns CHARACTER
The LinkGuid of the created Smart Link
Top

CHARACTER CreateObjectMaster (character, character, character, character, character, DictionaryAttributeValue)
Purpose: Creates an Object Master
Notes:

Parameters:
pcObjectName CHARACTER
The name of the object to create
pcObjectTypeGuid CHARACTER
The GUID or name of the object type
pcModuleGuid CHARACTER
The GUID or name of the product module
pcDescription CHARACTER
The optional description
pcDesignTimeDataSource CHARACTER
The ObjectMasterGuid of the Design Time DataSource
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The Dictionary of IAttributeValue instances
Returns CHARACTER
The Object Master Guid
Top

CHARACTER CreateObjectMaster (CreateObjectMasterParameter)
Purpose: Creates an Object Master
Notes:

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.CreateObjectMasterParameter
The CreateObjectMasterParameter instance for this call
Returns CHARACTER
The Object Master Guid
Top

CHARACTER CreateObjectMasterFromInstance (CreateObjectMasterFromInstanceParameter)
Purpose: Creates a new Object Master based on an Object Instance
Notes:

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.CreateObjectMasterFromInstanceParameter
The CreateObjectMasterFromInstanceParameter instance with the arguments for this call
Returns CHARACTER
The GUID of the new Object Master
Top

CHARACTER CreatePage (character, character, integer, character, character, character, character, character)
Purpose: Creates a Page in the customized variant of a Container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. See CreatePage

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
piPageSequence INTEGER
The page number
pcPageKey CHARACTER
The key of the page, empty for no page key
pcPageLabel CHARACTER
The label of the page
pcTabGroup CHARACTER
The tab group the page belongs to, only required when there are multiple tab folders on the page
pcPageIcon CHARACTER
The PNG image for the Desktop, relative path
pcPageIconWeb CHARACTER
The font based icon (e.g. Fontawesome) or relative PNG file name for the Web
Returns CHARACTER
The PageGuid of the created page
Top

CHARACTER CreatePage (character, integer, character)
Purpose: Creates a Page in a Container
Notes:

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
piPageSequence INTEGER
The page number
pcPageLabel CHARACTER
The label of the page
Returns CHARACTER
The PageGuid of the created Smart Link
Top

CHARACTER CreatePage (character, integer, character, character, character, character, character)
Purpose: Creates a Page in a Container
Notes: Rejects duplicate page numbers and duplicate page keys with
clear error messages. Empty optional values are not assigned

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
piPageSequence INTEGER
The page number
pcPageKey CHARACTER
The key of the page, empty for no page key
pcPageLabel CHARACTER
The label of the page
pcTabGroup CHARACTER
The tab group the page belongs to, only required when there are multiple tab folders on the page
pcPageIcon CHARACTER
The PNG image for the Desktop, relative path
pcPageIconWeb CHARACTER
The font based icon (e.g. Fontawesome) or relative PNG file name for the Web
Returns CHARACTER
The PageGuid of the created page
Top

CustomizeRepositoryData (handle)
Purpose: Customizes the repository data
Notes:

Parameters:
phDataset HANDLE
The dataset to customize
Top

CHARACTER DeleteLink (character, character, character, character)
Purpose: Deletes a SmartLink between two instances or the container
Notes: An empty source or target instance denotes the container itself

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcSourceInstance CHARACTER
The Instance GUID or instance name of the link source, empty when the link source is the container
pcTargetInstance CHARACTER
The Instance GUID or instance name of the link target, empty when the link target is the container
pcLinkType CHARACTER
The link type GUID or link type name
Returns CHARACTER
The LinkGuid of the deleted Smart Link
Top

CHARACTER DeleteLink (character, character, character, character, character)
Purpose: Deletes a SmartLink from the customized variant of a container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The links of the base object master are read-only
through a variant. See DeleteLink

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcSourceInstance CHARACTER
The Instance GUID or instance name of the link source, empty when the link source is the container
pcTargetInstance CHARACTER
The Instance GUID or instance name of the link target, empty when the link target is the container
pcLinkType CHARACTER
The link type GUID or link type name
Returns CHARACTER
The LinkGuid of the deleted Smart Link
Top

DeleteObjectInstance (character, character)
Purpose: Deletes an object instance from a container
Notes: Child instances are cascade-deleted together with the instance,
including the links and attribute values of every deleted
instance (through the referential integrity service)

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcInstance CHARACTER
The Instance Guid or Name of the instance to delete
Top

DeleteObjectInstance (character, character, character)
Purpose: Deletes an object instance from the customized variant of a container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The instances of the base object master are
read-only through a variant. See DeleteObjectInstance

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcInstance CHARACTER
The Instance Guid or Name of the instance to delete
Top

DeleteObjectMaster (character)
Purpose: Deletes a given object master
Notes: Does also delete contained instances, pages and links

Parameters:
pcDeleteContainer CHARACTER
The name or GUID of the container to be deleted
Top

CHARACTER DeletePage (character, character, integer)
Purpose: Deletes a Page from the customized variant of a Container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The pages of the base object master are read-only
through a variant. See DeletePage

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
piPageSequence INTEGER
The page number of the page to delete
Returns CHARACTER
The PageGuid of the deleted page
Top

CHARACTER DeletePage (character, integer)
Purpose: Deletes a Page from a Container
Notes: The object instances placed on the page are cascade-deleted
together with the page (through the referential integrity
service), including their child instances, links and
attribute values

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
piPageSequence INTEGER
The page number of the page to delete
Returns CHARACTER
The PageGuid of the deleted page
Top

dispose ()
Purpose: Disposes the service instance
Notes: CCS IService member, invoked by the ServiceContainer

Top

CHARACTER DuplicateObjectInstance (DuplicateObjectInstanceParameter)
Purpose: Creates a duplicate of the given object instance
Notes: Does also create copies of the instance attribute values. The
new instance receives a unique instance name within the
container (e.g. CustNum becomes CustNum2, CustNum2 becomes CustNum3)

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.DuplicateObjectInstanceParameter
The DuplicateObjectInstanceParameter instance with the parameters for this method
Returns CHARACTER
The ObjectInstanceGuid of the new object instance
Top

LOGICAL EnsureCustomizationResolution (character)
Purpose: Ensures that the customization topology of an object master is
resolved in the ttCustomizationResolution temp-table
Notes: SCL-5901: Positions the ttCustomizationResolution buffer on the
entry of the object master. Requires the SmartDB connection

Parameters:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the object master
Returns LOGICAL
Logical value indicating if the object master exists
Top

CHARACTER EnsureCustomizedObjectInstance (character, character)
Purpose: Ensures that the attribute values of an instance addressed through
a customized variant can be stored in the variant
Notes: SCL-5904: Returns the given ObjectInstanceGuid when the container is
not a customized variant or the instance belongs to the container.
For an instance of the base object master the customized (shadow)
instance of the same name is registered in the variant
(ObjectMasterBusinessEntity:RegisterCustomizedObjectInstance, RegisterCustomizedObjectInstance,
SCL-5899) and its ObjectInstanceGuid is returned

Parameters:
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
pcInstanceGuid CHARACTER
The ObjectInstanceGuid of the instance
Returns CHARACTER
The ObjectInstanceGuid of the customized instance or the given ObjectInstanceGuid
Top

CHARACTER EnsureGuids (character)
Purpose: Ensures that the list of classes contains GUIDs and not class names
Notes: Turns Class names into guids

Parameters:
pcClassNames CHARACTER
The comma delimited list of class names or class guids
Returns CHARACTER
The comma delimited list of class guids
Top

CHARACTER EnsureLinkTypeGuid (character)
Purpose: Ensures that the provided value is a Link Type Guid
Notes: Turns Link name into LinkTypeGuid

Parameters:
pcLinkTypeGuid CHARACTER
The link type name or guid to validate
Returns CHARACTER
The link type guid
Top

CHARACTER EnsureModuleGuid (character)
Purpose: Ensures that the provided value is a Product Module Guid
Notes: Turns Module name into ModuleGuid

Parameters:
pcModuleGuid CHARACTER
The module name or guid to validate
Returns CHARACTER
The module guid
Top

EnsureObjectTypeCache ()
Purpose: Ensures that the local object type cache is filled
Notes: SCL-5594 - the cache is filled from initialize (), this method
guards the consumers of the cache against an instance that was
constructed directly rather than through the ServiceContainer.
The reference is assigned before the Fill () call, so a repository
access issued while the cache is being filled (the fill performs
an OERA request, which may initialize further services that in
turn read the repository) sees the still empty cache and falls
back to the server rather than filling the cache a second time

Top

HANDLE FetchRepositoryObject (FetchRepositoryObjectParameter)
Purpose: Fetches an object from the repository
Notes: SCL-5900: When a customized variant of the container applies to
the request (see the CustomizationResultCode property of the
parameter), the pages, object instances and links of the variant
are merged into the repository data of the base container and the
attribute values of the variant are layered over the values of the
base (object type, base object master, customized object master,
object instance, customized object instance). The returned dataset
is an ordinary container dataset: pages, instances and links carry
the ObjectMasterGuid of the fetched object master as
ContainerObjectMasterGuid, customized (shadow) instances contribute
their attribute values to the base instance and never appear
themselves, the eSmartObjectMaster record carries the customization
result of the applied variant. The instances of the container
resolve the customized variants of their object masters with the
mode of the request

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.FetchRepositoryObjectParameter
The FetchRepositoryObjectParameter with the parameter for this call
Returns HANDLE
The handle of the dataset with the repository data
Top

HANDLE FetchRepositoryObject (IAnnotationBasedFormParameter)
Purpose: Fetches an annotation based form from the repository
Notes:

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.IAnnotationBasedFormParameter
The IAnnotationBasedFormParameter with the parameter for this call
Returns HANDLE
The handle of the dataset with the repository data
Top

CHARACTER FindCustomizedObjectInstance (character, character)
Purpose: Returns the ObjectInstanceGuid of the customized (shadow) instance
that holds the attribute values of an instance addressed through a
customized variant
Notes: SCL-5904: Returns the given ObjectInstanceGuid when the container is
not a customized variant or the instance belongs to the container.
For an instance of the base object master the customized instance
of the same name in the variant is returned, ? when the variant
has not customized the instance

Parameters:
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
pcInstanceGuid CHARACTER
The ObjectInstanceGuid of the instance
Returns CHARACTER
The ObjectInstanceGuid of the customized instance, the given ObjectInstanceGuid or ?
Top

Consultingwerk.SmartFramework.Repository.AttributeValue FindObjectInstanceAttributeValue (character, character, character)
Purpose: Returns the attribute value stored for an object instance
Notes: SCL-5900: Reads the SmartAttributeValue record of the object
instance only, no layer is applied

Parameters:
pcObjectInstanceGuid CHARACTER
The Object Instance GUID
pcAttributeLabel CHARACTER
The Attribute Label to return
pcDataType CHARACTER
The repository data type of the attribute
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance or ? when no value is stored for the object instance
Top

CHARACTER FindObjectInstanceGuid (character, character)
Purpose: Returns the Object Instance Guid of an instance of exactly the
given container
Notes: SCL-5904: Unlike GetObjectInstanceGuid the instances of the base
object master of a customized variant are not considered

Parameters:
pcContainerObjectMasterGuid CHARACTER
The ObjectMasterGuid of the container
pcInstance CHARACTER
The Instance Guid or Name
Returns CHARACTER
The Object Instance Guid or ? when the container has no such instance
Top

Consultingwerk.SmartFramework.Repository.AttributeValue FindObjectMasterAttributeValue (character, character, character)
Purpose: Returns the attribute value stored for an object master
Notes: SCL-5900: Reads the SmartAttributeValue record of the object master
only, no layer is applied

Parameters:
pcObjectMasterGuid CHARACTER
The Object Master GUID
pcAttributeLabel CHARACTER
The Attribute Label to return
pcDataType CHARACTER
The repository data type of the attribute
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance or ? when no value is stored for the object master
Top

LOGICAL FindObjectMasterByName (ObjectMasterDatasetModel, character)
Purpose: Positions the ObjectMasterDatasetModel on the object master with
the given object name
Notes: SCL-5897: An object name resolves to the base object master
(CustomizationResultGuid = ""). Customized variants share the
ObjectName of the base and are only addressed by their ObjectMasterGuid.
For compatibility with existing data, an object master that carries
a customization result (or the unknown value) but has no base is
still returned, as long as the object name is unique.
Callers must rely on the return value, not on the Available
property of the model

Parameters:
poObjectMaster Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel
The ObjectMasterDatasetModel to position
pcObjectName CHARACTER
The name of the object master
Returns LOGICAL
Logical value indicating if the object master was found
Top

CHARACTER FindPageGuid (ObjectMasterDatasetModel, character, character)
Purpose: Returns the PageGuid of a page of exactly the given container
Notes: SCL-5904

Parameters:
poPages Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel
The ObjectMasterDatasetModel to query the pages with
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
pcPage CHARACTER
The PageGuid or the page number of the page
Returns CHARACTER
The PageGuid of the page or ? when the container has no such page
Top

CHARACTER GetAttributeConstantLevel (character)
Purpose: Returns the constant level of the attribute
Notes:

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute
Returns CHARACTER
The constant level of the attribute
Top

CHARACTER GetAttributeDataType (character)
Purpose: Returns the repository type based of the attribute
Notes:

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute
Returns CHARACTER
The repository data type of the attribute
Top

CHARACTER GetAttributeLabel (character)
Purpose: Returns the repository label of the attribute
Notes: Useful to retrieve exact spelling/casing

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute
Returns CHARACTER
The label of the attribute
Top

CHARACTER GetAttributeTechnicalName (character)
Purpose: Returns the technical name of the attribute
Notes:

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute
Returns CHARACTER
The technical name of the attribute
Top

Consultingwerk.SmartFramework.Repository.AttributeValue GetAttributeValue (SmartAttributeValueTableModel, character, character)
Purpose: Returns the AttributeValue for the SmartAttributeValue record the
table model is positioned on
Notes:

Parameters:
poAttributeValue Consultingwerk.SmartFramework.Repository.Class.SmartAttributeValueTableModel
The SmartAttributeValueTableModel positioned on the attribute value
pcAttributeLabel CHARACTER
The Attribute Label to return
pcDataType CHARACTER
The repository data type of the attribute
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance
Top

CHARACTER GetBaseObjectMasterGuid (character)
Purpose: Returns the ObjectMasterGuid of the base object master of a
customized variant
Notes: SCL-5900: A customized variant shares the ObjectName of its base
object master (CustomizationResultGuid = ""). Returns the unknown
value when the object master is the base object master itself or
has no base (compatibility with existing data)

Parameters:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the customized variant
Returns CHARACTER
The ObjectMasterGuid of the base object master or ?
Top

CHARACTER GetChildClasses (character)
Purpose: Returns the comma delimited list of child class guids of the provided
parent classes
Notes:

Parameters:
pcObjectTypeGuids CHARACTER
The list of parent classes
Returns CHARACTER
The list of child class guids (including the parent classes)
Top

CHARACTER GetChildClassesFromCache (character)
Purpose: Returns the child-class hierarchy (parents plus all descendants) of
the given root class(es) resolved from the local object-type cache
Notes: SCL-5368 - mirrors the server-side ObjectTypeBusinessEntity:GetChildClasses
breadth-first walk of the ExtendsObjectTypeGuid chain, but against the
local cache so no AppServer request is issued. Returns the unknown
value when a root type is not cached, signalling the caller to fall
back to the server call.

Parameters:
pcObjectTypeGuids CHARACTER
The comma delimited list of root class guids or names
Returns CHARACTER
The comma delimited list of parent and descendant class guids, or ?
Top

CHARACTER GetCustomizedObjectMasterGuid (character, character)
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 of the object master exists wins (single
winner, no stacking of variants). Returns the unknown value when
the object master is not a base object master, when the list is
empty or when no variant exists for any of the codes

Parameters:
pcBaseObjectMasterGuid CHARACTER
The ObjectMasterGuid of the base object master
pcCustomizationResultCodes CHARACTER
The comma delimited list of customization result codes in prioritized order
Returns CHARACTER
The ObjectMasterGuid of the customized variant or ?
Top

Consultingwerk.OERA.IDataSourceInfo GetDataSourceInfo (character)
Purpose: Returns the IDataSourceInfo based on a repository object (MetaDataSource)
Notes:

Parameters:
pcDataSourceName CHARACTER
The name or GUID of the data source
Returns Consultingwerk.OERA.IDataSourceInfo
The IDataSourceInfo matching the repository object
Top

CHARACTER GetDesignTimeDataSourceGuid (character)
Purpose: Returns the GUID of the DesignTimeDataSource of the given
Object Master (GUID or Name) or Object Instance (GUID)
Notes:

Parameters:
pcObjectIdentifier CHARACTER
The Object Master (GUID or Name) or Object Instance (GUID)
Returns CHARACTER
The Object Master GUID of the DesignTimeDataSource or ?
Top

Consultingwerk.OERA.IDataSourceInfo GetDesignTimeDataSourceInfo (character)
Purpose: Returns the IDataSourceInfo based on a repository object's (MetaDataSource)
Design time data source
Notes:

Parameters:
pcObjectIdentifier CHARACTER
The Object Master (GUID or Name) or Object Instance (GUID)
Returns Consultingwerk.OERA.IDataSourceInfo
The IDataSourceInfo matching the repository object
Top

CHARACTER GetEntityFieldMapping (character, character, character, character)
Purpose: Returns the name fo the field object used to render
a given Business Entity Field
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcEntityTable CHARACTER
The name of the Business Entity Temp-Table
pcFieldName CHARACTER
The name of the Business Entity Field
pcEnvironment CHARACTER
The type of the rendering environment (GUI or WEB)
Returns CHARACTER
The name of the field object used to render the business entity field
Top

Consultingwerk.SmartFramework.Repository.ScreenMapping.ListScreenMapping GetEntityTableMapping (character, character, character)
Purpose: Returns the list of entity field mappings for the given Business EntityTable
and UI Types
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcEntityTable CHARACTER
The name of the Business Entity Temp-Table
pcUiTypeCode CHARACTER
The comma delimited list of UI Type Codes
Returns Consultingwerk.SmartFramework.Repository.ScreenMapping.ListScreenMapping
The List of ScreenMapping instances
Top

Progress.Json.ObjectModel.JsonObject GetJsonField (character, character, character, character, logical, logical, logical, handle, character)
Purpose: Renders a repository field as JSON
Notes: Fetches the Object Master Attributes from the repository

Parameters:
pcObjectName CHARACTER
The name of the repository field
pcScope CHARACTER
The scope to bind the field to (for additional properties)
pcFieldModel CHARACTER
The model to bind the field to
pcFieldName CHARACTER
The value for the name attribute
plMandatory LOGICAL
Logical value indicating if the field is mandatory
plReadOnly LOGICAL
Logical value indicating if the field is mandatory
plAddOnly LOGICAL
Logical value indicating if the field is only enable during add
phDataset HANDLE
The handle of the Business Entity Dataset
pcTables CHARACTER
The list of tables (entity table + entity view)
Returns Progress.Json.ObjectModel.JsonObject
The JSON representation of the field
Top

Progress.Json.ObjectModel.JsonObject GetJsonField (character, character, character, character, logical, logical, logical, handle, character, handle)
Purpose: Renders a repository field as JSON
Notes: Uses an externally provided attribute buffer (which can be an object master or an object instance)

Parameters:
pcObjectName CHARACTER
The name of the repository field
pcScope CHARACTER
The scope to bind the field to (for additional properties)
pcFieldModel CHARACTER
The model to bind the field to
pcFieldName CHARACTER
The value for the name attribute
plMandatory LOGICAL
Logical value indicating if the field is mandatory
plReadOnly LOGICAL
Logical value indicating if the field is mandatory
plAddOnly LOGICAL
Logical value indicating if the field is only enable during add
phDataset HANDLE
The handle of the Business Entity Dataset
pcTables CHARACTER
The list of tables (entity table + entity view)
phAttributesBuffer HANDLE
The buffer with the attributes of the object
Returns Progress.Json.ObjectModel.JsonObject
The JSON representation of the field
Top

Progress.Json.ObjectModel.JsonObject GetJsonField (handle, handle, character, character, character, logical, logical, logical, IBusinessEntityDescriptor, handle, character, LayoutStyleEnum)
Purpose: Renders a repository field as JSON
Notes: Renders based on previously fetched repository data

Parameters:
phObjectInstanceBuffer HANDLE
The handle of the Buffer with the instance data
phAttributesBuffer HANDLE
The handle of the Buffer with the instance attributes
pcScope CHARACTER
The scope to bind the field to (for additional properties)
pcFieldModel CHARACTER
The model to bind the field to
pcFieldName CHARACTER
The value for the name attribute
plMandatory LOGICAL
Logical value indicating if the field is mandatory
plReadOnly LOGICAL
Logical value indicating if the field is mandatory
plAddOnly LOGICAL
Logical value indicating if the field is only enable during add
poDescriptor Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
The reference to the Business Entity Descriptor
phDataset HANDLE
The handle of the Business Entity Dataset
pcTables CHARACTER
The list of tables (entity table + entity view)
poLayoutStyle Consultingwerk.Web2.Services.Rendering.Viewer.LayoutStyleEnum
The LayoutStyle Pixel / Responsive
Returns Progress.Json.ObjectModel.JsonObject
The JSON representation of the field
Top

CHARACTER GetLinkTypeGuid (character)
Purpose: Returns the Link Type Guid based on a Link Type Name or a link
type guid
Notes: Throws an error when the link type cannot be found

Parameters:
pcLinkType CHARACTER
The Link Type Name or Link Type Guid
Returns CHARACTER
The Link Type Guid
Top

INTEGER GetMaxObjectSequence (ObjectMasterDatasetModel, character)
Purpose: Returns the highest object sequence of the instances of a container
Notes: SCL-5904: Used to default the object sequence of a new instance,
for a customized variant the instances of the base object master
count as well

Parameters:
poInstances Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel
The ObjectMasterDatasetModel to query the instances with
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
Returns INTEGER
The highest object sequence, 0 when the container has no instances
Top

Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectInstanceAttributeValue (character, character)
Purpose: Returns a single Attribute Value assigned to an Object Instance
Notes: SCL-5900: The value is resolved through the layers customized
(shadow) object instance, object instance, customized object
master, object master and object type. The customized variant of
the container of the instance is resolved from the customization
result codes of the session; for an instance of a customized variant
the instance itself is the customized instance of the base instance
of the same name and the object master of the instance resolves the
variant of the customization result of that container

Parameters:
pcObjectInstanceGuid CHARACTER
The Object Instance GUID
pcAttributeLabel CHARACTER
The Attribute Label to return
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance
Top

CHARACTER GetObjectInstanceGuid (character, character)
Purpose: Returns the Object Instance Guid based on an Container Object
Master Name or guid and an Instance Name or guid
Notes: Defaults to throwing errors when the instance cannot be found

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcInstance CHARACTER
The Instance Guid or Name
Returns CHARACTER
The Object Instance Guid
Top

CHARACTER GetObjectInstanceGuid (character, character, logical)
Purpose: Returns the Object Instance Guid based on an Container Object
Master Name or guid and an Instance Name or guid
Notes:

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcInstance CHARACTER
The Instance Guid or Name
plThrowOnNotAvailable LOGICAL
Logical value indicating if the method throws an error when the object master cannot be found
Returns CHARACTER
The Object Instance Guid
Top

Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectMasterAttributeValue (character, character)
Purpose: Returns a single Attribute Value assigned to an
Object Master
Notes: SCL-5900: The value is resolved through the layers customized object
master, object master and object type. The customized variant of
the object master is resolved from the customization result codes
of the session; the ObjectMasterGuid of a customized variant
resolves that variant

Parameters:
pcObjectMaster CHARACTER
The Object Master GUID or Name
pcAttributeLabel CHARACTER
The Attribute Label to return
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance
Top

Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectMasterAttributeValue (character, character, character)
Purpose: Returns a single Attribute Value assigned to an
Object Master
Notes: SCL-5900: The value is resolved through the layers customized object
master, object master and object type. The customized variant of
the object master is resolved from the customization result code
(see ResolveCustomizedObjectMaster for the tri-state semantics)

Parameters:
pcObjectMaster CHARACTER
The Object Master GUID or Name
pcAttributeLabel CHARACTER
The Attribute Label to return
pcCustomizationResultCode CHARACTER
The customization result code (?, "" or a code)
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance
Top

CHARACTER GetObjectMasterCustomizationResultCode (character)
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:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the object master
Returns CHARACTER
The customization result code of the object master
Top

CHARACTER GetObjectMasterDescription (character)
Purpose: Returns the Object Master Description based on an Object Master Name
or an object type guid
Notes:

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
Returns CHARACTER
The Object Master Description
Top

CHARACTER GetObjectMasterGuid (character)
Purpose: Returns the Object Master Guid based on an Object Master Name
or an object master guid
Notes: Defaults to throwing errors when the master cannot be found

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
Returns CHARACTER
The Object Master Guid
Top

CHARACTER GetObjectMasterGuid (character, character, logical)
Purpose: Returns the Object Master Guid of the customized variant of an
object master for a customization result code
Notes: SCL-5904: The object master is addressed by the name or the
ObjectMasterGuid of its base or of one of its customized variants.
An empty or unknown customization result code returns the base
object master, a code returns the variant of that code

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
plThrowOnNotAvailable LOGICAL
Logical value indicating if the method throws an error when the object master or the variant cannot be found
Returns CHARACTER
The Object Master Guid of the variant or of the base object master, ? when not available
Top

CHARACTER GetObjectMasterGuid (character, logical)
Purpose: Returns the Object Master Guid based on an Object Master Name
or an object master guid
Notes:

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
plThrowOnNotAvailable LOGICAL
Logical value indicating if the method throws an error when the object master cannot be found
Returns CHARACTER
The Object Master Guid
Top

CHARACTER GetObjectMasterGuidFromInstanceGuid (character)
Purpose: Returns the Object Master Guid based on an Object Instance GUID
Notes: Defaults to throwing errors when the master cannot be found

Parameters:
pcInstanceGuid CHARACTER
The Object Instance Guid
Returns CHARACTER
The Object Master Guid
Top

CHARACTER GetObjectMasterGuidFromInstanceGuid (character, logical)
Purpose: Returns the Object Master Guid based on an Object Instance GUID
Notes:

Parameters:
pcInstanceGuid CHARACTER
The Object Instance Guid
plThrowOnNotAvailable LOGICAL
Logical value indicating if the method throws an error when the object master cannot be found
Returns CHARACTER
The Object Master Guid
Top

CHARACTER GetObjectMasterName (character)
Purpose: Returns the Object Master Name based on an Object Master Name
or an object type guid
Notes: Defaults to throwing errors when the object master cannot be found

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
Returns CHARACTER
The Object Master Name
Top

CHARACTER GetObjectMasterName (character, logical)
Purpose: Returns the Object Master Name based on an Object Master Name
or an object type guid
Notes: Returns the unknown value when the object master cannot be found
and plThrowOnNotAvailable is false

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
plThrowOnNotAvailable LOGICAL
Logical value indicating if the method throws an error when the object master cannot be found
Returns CHARACTER
The Object Master Name
Top

Consultingwerk.Framework.Collections.CharacterList GetObjectsWithAttributeValues (DictionaryAttributeValue)
Purpose: Returns a list of objects with the given attribute values
Notes: Useful to locate DataSource's for a given Business Entity etc.

Parameters:
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The DictionaryAttributeValue with the attribute values
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the object names
Top

Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectTypeAttributeValue (character, character)
Purpose: Returns a single Attribute Value assigned to an
Object Master
Notes:

Parameters:
pcObjectType CHARACTER
The Object Type GUID or Name
pcAttributeLabel CHARACTER
The Attribute Label to return
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance
Top

Consultingwerk.SmartFramework.Repository.AttributeValue GetObjectTypeAttributeValue (character, character, character)
Purpose: Returns a single Attribute Value assigned to an
Object Master
Notes:

Parameters:
pcObjectType CHARACTER
The Object Type GUID or Name
pcAttributeLabel CHARACTER
The Attribute Label to return
pcDataType CHARACTER
The attributes repository data-type
Returns Consultingwerk.SmartFramework.Repository.AttributeValue
The AttributeValue instance
Top

CHARACTER GetObjectTypeEvents (character)
Purpose: Returns the comma-delimited list of event names defined for an
object type
Notes: Events are the design-time attributes of the object type with the
PropertyOrEvent flag set to false. The list is built from the
object type's design attributes (including those contributed by a
custom object type) so that it matches the events available on the
object masters and object instances of the object type.

Parameters:
pcObjectType CHARACTER
The Object Type Name or Object Type Guid
Returns CHARACTER
The comma-delimited list of event names defined for the object type
Top

CHARACTER GetObjectTypeFieldFromCache (character, character)
Purpose: Returns a field value of an object type resolved from the local
object-type cache, or the unknown value when the type is not cached
Notes: SCL-5368 - the cache (oCacheObjectType) is filled with all object
types on initialization, so name / guid lookups do not require an
AppServer round-trip. Accepts either the ObjectTypeGuid or the
ObjectTypeName as the lookup value.

Parameters:
pcObjectType CHARACTER
The object type guid or name to resolve
pcFieldName CHARACTER
The name of the eSmartObjectType field to return
Returns CHARACTER
The requested field value, or ? when the object type is not cached
Top

CHARACTER GetObjectTypeGuid (character)
Purpose: Returns the Object Type Guid based on an Object Type Name
or an object type guid
Notes:

Parameters:
pcObjectType CHARACTER
The Object Type Name or Object Type Guid
Returns CHARACTER
The Object Type Guid
Top

CHARACTER GetObjectTypeGuidOfMaster (character)
Purpose: Returns the Object Type Guid of the given object master
Notes: Supports object master guid and object master name

Parameters:
pcObjectMaster CHARACTER
The object master guid or name
Returns CHARACTER
The object type guid of the given object master
Top

CHARACTER GetObjectTypeName (character)
Purpose: Returns the Object Type Name based on an Object Type Name
or an object type guid
Notes: Defaults to throwing errors when the object type cannot be found

Parameters:
pcObjectType CHARACTER
The Object Type Name or Object Type Guid
Returns CHARACTER
The Object Type Name
Top

CHARACTER GetObjectTypeName (character, logical)
Purpose: Returns the Object Type Name based on an Object Type Name
or an object type guid
Notes: Returns the unknown value when the object type cannot be found
and plThrowOnNotAvailable is false

Parameters:
pcObjectType CHARACTER
The Object Type Name or Object Type Guid
plThrowOnNotAvailable LOGICAL
Logical value indicating if the method throws an error when the object type cannot be found
Returns CHARACTER
The Object Type Name
Top

CHARACTER GetParentClasses (character)
Purpose: Returns the CHR(1) delimited list of parent class guids of the provided
child class
Notes:

Parameters:
pcObjectTypeGuid CHARACTER
The child class guid
Returns CHARACTER
The list of parent class guids
Top

CHARACTER GetProductModuleDataFolder (character)
Purpose: Returns the Data Folder of the given Product Module
Notes: Throws an exception, when the module does not have a data folder

Parameters:
pcModuleGuid CHARACTER
The guid of the Product Module
Returns CHARACTER
The data folder of the given product module
Top

CHARACTER GetProductModuleGuid (character)
Purpose: Returns the Product Module Guid based on an Product Module Name
or an product module guid
Notes:

Parameters:
pcProductModule CHARACTER
The Product Module Name or Product Module Guid
Returns CHARACTER
The Product Module Guid
Top

CHARACTER GetSessionCustomizationResultCodes ()
Purpose: Returns the customization result codes of the current session
Notes: SCL-5900: The codes resolved by the ICustomizationResultService at
login (SCL-5898), kept in SessionManager:CustomizationResultCodes and
restored from the session context on every PASOE request. When the
codes have not been resolved yet and the service is registered, the
service resolves them now

Returns CHARACTER
The comma delimited list of customization result codes in prioritized order, an empty string when the session has none
Top

initialize ()
Purpose: Initializes the service instance
Notes: CCS IService member, invoked by the ServiceContainer after the
service instance has been registered (see SCL-5594). Filling the
object type cache issues an OERA request, so it must not run
from the constructor - at that time the service is not yet
registered and a repository access performed while the request
initializes further services would construct and register a
second instance of this service

Top

InvalidateCustomizationCaches (ObjectMasterChangedEventArgs)
Purpose: Removes the entries of a changed object master and of the object
masters of the same name (its base and its customized variants)
from the resolution cache and their repository data from the
ISmartRepositoryCache
Notes: SCL-5901: Changing a base object master invalidates the cached
repository data of all of its customized variants, creating or
deleting a variant invalidates the resolution of the base. The
entries of the ISmartRepositoryCache are keyed by the container
name of the request, which is the object name or the
ObjectMasterGuid of the base or of a variant

Parameters:
e Consultingwerk.SmartFramework.Repository.ObjectMasterChangedEventArgs
The ObjectMasterChangedEventArgs with the data of the change
Top

LOGICAL IsLinkSupported (character, character, character)
Purpose: Verifies if the given link is valid
Notes: Verifies for the supported Links of the given classes and their
parent classes

Parameters:
pcSourceClassGuid CHARACTER
The GUID or Name of the source class
pcLinkTypeGuid CHARACTER
The GUID of Name of the SmartLink
pcTargetClassGuid CHARACTER
The GUID or Name of the target class
Returns LOGICAL
Logical value indicating if the given link type is value
Top

CHARACTER MapCustomizedInstanceGuid (handle, character)
Purpose: Maps the ObjectInstanceGuid of a customized (shadow) instance to
the ObjectInstanceGuid of its base instance
Notes: SCL-5900: Returns the given ObjectInstanceGuid when it does not
belong to a customized instance

Parameters:
phCustomizedInstanceMap HANDLE
The buffer of the temp-table with the mapping of the base instances to their customized instances
pcObjectInstanceGuid CHARACTER
The ObjectInstanceGuid to map
Returns CHARACTER
The ObjectInstanceGuid of the base instance or the given ObjectInstanceGuid
Top

CHARACTER MapCustomizedInstanceToBase (character, character)
Purpose: Returns the ObjectInstanceGuid of the base instance of a customized
(shadow) instance of a customized variant
Notes: SCL-5904: Returns the given ObjectInstanceGuid when the container is
not a customized variant, when the instance does not belong to the
container or when the base object master has no instance of the
same name. Parent and link references of a variant refer to the
base instance, never to its customized instance, so that a
customized instance can be removed together with its last override

Parameters:
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
pcInstanceGuid CHARACTER
The ObjectInstanceGuid of the instance
Returns CHARACTER
The ObjectInstanceGuid of the base instance or the given ObjectInstanceGuid
Top

MergeCustomizedObjectMaster (handle, handle, handle)
Purpose: Merges the pages, object instances and links of a customized
variant of a container into the repository data of the base container
Notes: SCL-5900: The pages, instances and links of the variant are added to
the dataset of the base with the ObjectMasterGuid of the base as
ContainerObjectMasterGuid, so that the merged dataset is an ordinary
container dataset. An instance of the variant whose InstanceName
exists in the base is the customized (shadow) instance of that base
instance (SCL-5899): it is not added, the base ObjectInstanceGuid
stays the identity and the customized instance is registered in the
map, so that its attribute values are layered over the values of the
base instance. Parent and link references to a customized instance
are mapped to the base instance. A page of the variant with the
PageSequence of a base page and a link of the variant that exists in
the base violate the validation rules of SCL-5899, they are skipped
and logged. The eSmartObjectMaster record of the base receives the
customization result of the variant

Parameters:
phDataset HANDLE
The dataset with the repository data of the base container
phVariantDataset HANDLE
The dataset with the repository data of the customized variant
phCustomizedInstanceMap HANDLE
The buffer of the temp-table that receives the mapping of the base instances (ObjectInstanceGuid) to their customized instances (CustomizedObjectInstanceGuid)
Top

MoveObjectInstance (character, character, character)
Purpose: Moves an object instance to another parent instance within the
same container
Notes: An empty new parent instance moves the instance to the top level.
The new parent must be located on the same page as the instance
and must not be the instance itself or one of its child instances

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcInstance CHARACTER
The Instance Guid or Name of the instance to move
pcNewParentInstance CHARACTER
The Instance Guid or Name of the new parent instance, empty for top level
Top

MoveObjectInstance (character, character, character, character)
Purpose: Moves an object instance of the customized variant of a container
to another parent instance
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The instances of the base object master are
read-only through a variant, the new parent may be an instance of
the base object master. See MoveObjectInstance

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcInstance CHARACTER
The Instance Guid or Name of the instance to move
pcNewParentInstance CHARACTER
The Instance Guid or Name of the new parent instance, empty for the top level
Top

LOGICAL ObjectIsA (character, character)
Purpose: Returns if the object is of the given class
Notes:

Parameters:
pcObjectName CHARACTER
The name of the object to verify
pcClassName CHARACTER
The name of the class to test if the object is a child of
Returns LOGICAL
Logical value indicating if the object is child of the given class
Top

OnObjectMasterChanged (ObjectMasterChangedEventArgs)
Purpose: Raises the ObjectMasterChanged event
Notes: SCL-5821

Parameters:
e Consultingwerk.SmartFramework.Repository.ObjectMasterChangedEventArgs
The ObjectMasterChangedEventArgs with the data for this event
Top

OnObjectMasterProductModuleChanged (ObjectMasterProductModuleChangedEventArgs)
Purpose: Raises the ObjectMasterProductModuleChanged event
Notes:

Parameters:
e Consultingwerk.SmartFramework.Repository.ObjectMasterProductModuleChangedEventArgs
The ObjectMasterProductModuleChangedEventArgs with the data for this event
Top

RaiseObjectMasterChanged (ObjectMasterChangedEventArgs)
Purpose: Raises the ObjectMasterChanged event
Notes: SCL-5821

Parameters:
e Consultingwerk.SmartFramework.Repository.ObjectMasterChangedEventArgs
The ObjectMasterChangedEventArgs with the data for this event
Top

RaiseObjectMasterProductModuleChanged (ObjectMasterProductModuleChangedEventArgs)
Purpose: Raises the ObjectMasterProductModuleChanged event
Notes:

Parameters:
e Consultingwerk.SmartFramework.Repository.ObjectMasterProductModuleChangedEventArgs
The ObjectMasterProductModuleChangedEventArgs with the data for this event
Top

RemoveUnusedCustomizedObjectInstance (character, character)
Purpose: Removes a customized (shadow) instance of a customized variant that
does no longer override attribute values of its base instance
Notes: SCL-5904: Removing the last override of a base instance removes the
customized instance again. SCL-5912: Delegates to
ObjectMasterBusinessEntity:RemoveUnusedCustomizedObjectInstance, RemoveUnusedCustomizedObjectInstance,
which keeps the instance while it still holds attribute values or
while links or child instances of the variant refer to it

Parameters:
pcContainerGuid CHARACTER
The ObjectMasterGuid of the customized variant
pcInstanceGuid CHARACTER
The ObjectInstanceGuid of the customized instance
Top

ReplaceObjectInstance (character, character)
Purpose: Replaces an Object instance with a new object master
Notes: Keeps compatible attributes and removes incompatible attributes
Defaults to not to rename the instance to match the new master name

Parameters:
pcObjectInstanceGuid CHARACTER
The GUID of the object instance to replace
pcObjectMasterGuid CHARACTER
The GUID of the new object master
Top

ReplaceObjectInstance (character, character, logical)
Purpose: Replaces an Object instance with a new object master
Notes: Keeps compatible attributes

Parameters:
pcObjectInstanceGuid CHARACTER
The GUID of the object instance to replace
pcObjectMasterGuid CHARACTER
The GUID of the new object master
plRenameInstance LOGICAL
Rename instance to match object master name
Top

ResetDesignAttributes (character)
Purpose: Marks the given attributes as inherited in the
dsDesignAttributeValues Dataset
Notes: Storing a design attribute with the IsInherited flag set deletes
the attribute value record, so the inherited value applies again

Parameters:
pcAttributeNames CHARACTER
The comma delimited list of attribute names to reset
Top

ResetObjectInstanceAttributes (character, character, character)
Purpose: Resets the given Attributes of an Object Instance to their
inherited values
Notes: Deletes the attribute value records of the given attributes so
that the values inherited from the object master or object type
apply again

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcInstance CHARACTER
The Instance Guid or Name
pcAttributeNames CHARACTER
The comma delimited list of attribute names to reset
Top

ResetObjectInstanceAttributes (character, character, character, character)
Purpose: Resets the given Attributes of an Object Instance addressed through
the customized variant of a container to their inherited values
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. Resetting the last override of an instance of the
base object master removes the customized (shadow) instance of the
variant again. See ResetObjectInstanceAttributes

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcInstance CHARACTER
The Instance Guid or Name
pcAttributeNames CHARACTER
The comma delimited list of attribute names to reset
Top

ResetObjectMasterAttributes (character, character)
Purpose: Resets the given Attributes of an Object Master to their
inherited values
Notes: Deletes the attribute value records of the given attributes so
that the values inherited from the object type apply again

Parameters:
pcObjectMaster CHARACTER
The GUID or name of the object master
pcAttributeNames CHARACTER
The comma delimited list of attribute names to reset
Top

ResetObjectMasterAttributes (character, character, character)
Purpose: Resets the given Attributes of the customized variant of an Object
Master to their inherited values
Notes: SCL-5904: The object master is addressed by name (or
ObjectMasterGuid) and customization result code, an empty code
addresses the base object master. See ResetObjectMasterAttributes

Parameters:
pcObjectMaster CHARACTER
The GUID or name of the object master
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcAttributeNames CHARACTER
The comma delimited list of attribute names to reset
Top

ResolveCustomizedObjectMaster (character, character, character, character)
Purpose: Resolves the base object master and the customized variant of an
object master that applies to a request
Notes: SCL-5900: The customization result code is tri-state: the unknown
value resolves the variant from the customization result codes of
the session (the first code for which a variant exists wins), an
empty string applies the base object master only and a code applies
exactly the variant of that code, without falling back to the codes
of the session. A customized variant addressed by its ObjectMasterGuid
is always applied, regardless of the code

Parameters:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the object master addressed by the request, the base object master or a customized variant
pcCustomizationResultCode CHARACTER
The customization result code of the request (?, "" or a code)
pcBaseObjectMasterGuid CHARACTER
OUTPUT The ObjectMasterGuid of the base object master
pcCustomizedObjectMasterGuid CHARACTER
OUTPUT The ObjectMasterGuid of the customized variant that applies to the request, ? when none applies
Top

CHARACTER ResolvePageGuid (character, character)
Purpose: Resolves the PageGuid of a page of a container from a PageGuid or
a page number
Notes: SCL-5904: The pages of the base object master are resolved for a
customized variant as well, an instance of a variant can be placed
on a page of the base

Parameters:
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
pcPage CHARACTER
The PageGuid or the page number of the page
Returns CHARACTER
The PageGuid of the page
Top

SetAbsolutePosition (JsonObject, handle)
Purpose: Updates a JSON Layout with absolute position
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JSON Object representing the current component
phAttributesBuffer HANDLE
The buffer with the attributes
Top

SetWebClassList (JsonObject, character)
Purpose: Updates a JSON Layout with the web style list of the viewer field
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JSON Object representing the current component
pcWebClassList CHARACTER
The comma delimited list of CCS classes
Top

StoreObjectInstanceAttributes (character, character, character, DictionaryAttributeValue)
Purpose: Stores the given Attributes for an Object Instance addressed
through the customized variant of a container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The values of an instance of the base object master
are stored on the customized (shadow) instance of the variant,
which is registered on the first override. See
StoreObjectInstanceAttributes

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
pcInstance CHARACTER
The Instance Guid or Name
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The DictionaryAttributeValue with the attributes to store
Top

StoreObjectInstanceAttributes (character, character, DictionaryAttributeValue)
Purpose: Stores the given Attributes for an Object Instance
Notes:

Parameters:
pcContainerObjectMaster CHARACTER
The Container Object Master Name or Object Master Guid
pcInstance CHARACTER
The Instance Guid or Name
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The DictionaryAttributeValue with the attributes to store
Top

StoreObjectMasterAttributes (character, character, DictionaryAttributeValue)
Purpose: Stores the given Attributes for the customized variant of an
Object Master
Notes: SCL-5904: The object master is addressed by name (or
ObjectMasterGuid) and customization result code, an empty code
addresses the base object master. See StoreObjectMasterAttributes

Parameters:
pcObjectMaster CHARACTER
The GUID or name of the object master
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The DictionaryAttributeValue with the attributes to store
Top

StoreObjectMasterAttributes (character, DictionaryAttributeValue)
Purpose: Stores the given Attributes for an Object Master
Notes:

Parameters:
pcObjectMaster CHARACTER
The GUID or name of the object master
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The DictionaryAttributeValue with the attributes to store
Top

LOGICAL SupportsInstanceOfType (character, character)
Purpose: Returns if the Container supports instances of the given type
Notes: Facade to SupportsInstanceOfTypeProvider:SupportsInstanceOfType()

Parameters:
pcContainerObjectType CHARACTER
The GUID or name of the container object type
pcInstanceObjectType CHARACTER
The GUID or name of the instance object type
Returns LOGICAL
Logical value indicating if the container supports instances of the given type
Top

UpdateDesignAttributes (DictionaryAttributeValue)
Purpose: Updates the dsDesignAttributeValues Dataset based on the
passed in Attributes Dictionary
Notes:

Parameters:
poAttributes Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue
The Dictionary of IAttributeValue instances
Top

CHARACTER UpdatePage (character, character, integer, character, character, character, character, character)
Purpose: Updates an existing Page of the customized variant of a Container
Notes: SCL-5904: The container is addressed by name (or ObjectMasterGuid)
and customization result code, an empty code addresses the base
object master. The pages of the base object master are read-only
through a variant. See UpdatePage

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcCustomizationResultCode CHARACTER
The customization result code of the variant, empty for the base object master
piPageSequence INTEGER
The page number of the page to update
pcPageKey CHARACTER
The key of the page, only updated when provided
pcPageLabel CHARACTER
The label of the page, only updated when provided
pcTabGroup CHARACTER
The tab group the page belongs to, only updated when provided
pcPageIcon CHARACTER
The PNG image for the Desktop, only updated when provided
pcPageIconWeb CHARACTER
The font based icon or relative PNG file name for the Web, only updated when provided
Returns CHARACTER
The PageGuid of the updated page
Top

CHARACTER UpdatePage (character, integer, character, character, character, character, character)
Purpose: Updates an existing Page of a Container
Notes: Only the provided (non-empty) values are applied - empty
parameters leave the current value unchanged

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
piPageSequence INTEGER
The page number of the page to update
pcPageKey CHARACTER
The key of the page, only updated when provided
pcPageLabel CHARACTER
The label of the page, only updated when provided
pcTabGroup CHARACTER
The tab group the page belongs to, only updated when provided
pcPageIcon CHARACTER
The PNG image for the Desktop, only updated when provided
pcPageIconWeb CHARACTER
The font based icon or relative PNG file name for the Web, only updated when provided
Returns CHARACTER
The PageGuid of the updated page
Top

ValidatePages (character, handle, integer[])
Purpose: Validates the Pages parameter of the FetchRepositoryObject parameter
Notes:

Parameters:
pcObjectMaster CHARACTER
The object master name
phPagesBuffer HANDLE
The buffer of the eSmartPage temp-table
piPages INTEGER
The Integer extent with the list of pages to retrieve
Top

VerifyContainerSecurity (character)
Purpose: Verifies users access to the repository master
Notes:

Parameters:
pcObjectName CHARACTER
The name of the repository object
Top

VerifyInstanceOwnedByContainer (character, character, character)
Purpose: Verifies that an object instance belongs to a container and not to
the base object master of the container
Notes: SCL-5904: The instances of the base object master are read-only
through a customized variant, the variant can only customize
their attribute values

Parameters:
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
pcInstanceGuid CHARACTER
The ObjectInstanceGuid of the instance
pcInstance CHARACTER
The instance name or guid as passed by the caller
Top

VerifyPageNotInBase (character, integer)
Purpose: Verifies that a page does not belong to the base object master of
a customized variant
Notes: SCL-5904: The pages of the base object master are read-only through
a customized variant

Parameters:
pcContainerGuid CHARACTER
The ObjectMasterGuid of the container
piPageSequence INTEGER
The page number


Constructor Detail
Top

SmartRepositoryService ()
Purpose: Constructor for the SmartRepositoryService class
Notes: SCL-5594 - the constructor is deliberately free of OERA side
effects. The object type cache is filled from the CCS IService
initialize () method, which the ServiceContainer invokes after
the service has been registered, so a repository access that is
triggered while the cache is being filled resolves this very
instance instead of constructing and registering a second one



Event Detail
Top

ObjectMasterChanged (Object, ObjectMasterChangedEventArgs)
Purpose: Event raised after an Object Master, or one of the pages, object
instances or links of a container, has been saved
Notes: SCL-5821. Raised server-side by the Business Entities that
maintain Object Masters, after the data has been written and
once per affected Object Master. Changes to attribute values do
not raise the event. Handlers must not throw errors, the data
has already been saved when the event is raised

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartFramework.Repository.ObjectMasterChangedEventArgs
The ObjectMasterChangedEventArgs with the data for this event
Top

ObjectMasterProductModuleChanged (Object, ObjectMasterProductModuleChangedEventArgs)
Purpose: Event raised when the Product Module of an Object Master is changed
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartFramework.Repository.ObjectMasterProductModuleChangedEventArgs
The ObjectMasterProductModuleChangedEventArgs with the data for this event


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:31:01