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: Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService, Consultingwerk.SmartFramework.Repository.ISmartRepositoryService


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



Top Method Summary
Options Name Purpose
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
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, integer) 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 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, integer, character) Creates a Page in a Container
CustomizeRepositoryData (handle) Customizes the repository data
DeleteObjectMaster (character) Deletes a given object master
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
HANDLE FetchRepositoryObject (FetchRepositoryObjectParameter) Fetches an object from the repository
HANDLE FetchRepositoryObject (IAnnotationBasedFormParameter) Fetches an annotation based form from the repository
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
CHARACTER GetChildClasses (character) Returns the comma delimited list of child class guids of the provided parent classes
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
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
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, 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
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 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 Guid 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
LOGICAL IsLinkSupported (character, character, character) Verifies if the given link is valid
LOGICAL ObjectIsA (character, character) Returns if the object is of the given class
OnObjectMasterProductModuleChanged (ObjectMasterProductModuleChangedEventArgs) Raises the ObjectMasterProductModuleChanged event
RaiseObjectMasterProductModuleChanged (ObjectMasterProductModuleChangedEventArgs) Raises the ObjectMasterProductModuleChanged event
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
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, DictionaryAttributeValue) Stores the given Attributes for an Object Instance
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
ValidatePages (character, handle, integer[]) Validates the Pages parameter of the FetchRepositoryObject parameter
VerifyContainerSecurity (character) Verifies users access to the repository master

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

Top Event Summary
Options Name Purpose
ObjectMasterProductModuleChanged (Object, ObjectMasterProductModuleChangedEventArgs) Event raised when the Product Module of an Object Master is changed


Method Detail
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

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, 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, 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:

Parameters:
pcContainerObject CHARACTER
The Container Object Master GUID or Container Object Name
pcSourceInstance CHARACTER
The Instance GUID or instance name of the link source
pcTargetInstance CHARACTER
The Instance GUID or instance name of the link target
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, 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

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

Parameters:
phDataset HANDLE
The dataset to customize
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 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

HANDLE FetchRepositoryObject (FetchRepositoryObjectParameter)
Purpose: Fetches an object from the repository
Notes:

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 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

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

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

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

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:

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

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, 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:

Parameters:
pcObjectMaster CHARACTER
The Object Master Name or Object Master Guid
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 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 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 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

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

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

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

Parameters:
e Consultingwerk.SmartFramework.Repository.ObjectMasterProductModuleChangedEventArgs
The ObjectMasterProductModuleChangedEventArgs 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

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

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, 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, 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

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


Constructor Detail
Top

SmartRepositoryService ()
Purpose: Constructor for the SmartRepositoryService class
Notes:



Event Detail
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       13.04.2026 10:27:13