Namespace: Consultingwerk.SmartFramework.Repository
Interface 
ISmartRepositoryService Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
Implemented by: Consultingwerk.SmartFramework.Repository.SmartRepositoryService

Purpose: Event raised when the Product Module of an Object Master is changed
Notes:

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



Top Method Summary
Options Name Purpose
+ LOGICAL ClassIsA (character, character) Returns if the child class is a child of the given parent class
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
+ ClearCaches () Clears all caches of this class
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
+ 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
+ DeleteObjectMaster (character) Deletes a given object master
+ CHARACTER EnsureGuids (character) Ensures that the list of classes contains GUIDs and not class names
+ HANDLE FetchRepositoryObject (FetchRepositoryObjectParameter) Fetches an object from the repository
+ HANDLE FetchRepositoryObject (IAnnotationBasedFormParameter) Fetches an annotation based form from the repository
+ HANDLE GetAttributeBuffer (character, character, handle) Returns a buffer to the attribute of a given object master (when pcInstanceName is empty) or named object instance
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
+ HANDLE GetAttributeBuffer (character, handle) Returns a buffer to the attribute of a given object master (when pcInstanceName is empty) or named object instance
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
+ 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 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
+ LONGCHAR GetHtmlField (character, character, character, character, character, logical, logical, handle, character, ViewerBindingStyleEnum) Renders a repository field as html
+ LONGCHAR GetHtmlField (character, character, character, character, character, logical, logical, handle, character, ViewerBindingStyleEnum, handle) Renders a repository field as html
+ 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
+ SmartBusinessEntityLookupDescriptor GetLookupDescriptor (character) Returns a SmartBusinessEntityLookupDescriptor for the repository
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
+ 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 Master Name or an object master 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
+ 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 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
+ 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
+ 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

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


Method Detail
Top

PUBLIC LOGICAL ClassIsA (character, character)
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
Purpose: Returns if the child class is a child of the given parent class
Notes:

Parameters:
pcChildClassName CHARACTER
The name of the child class to verify
pcParentClassName CHARACTER
The name of the parent class to test if the given child class is a child of
Returns LOGICAL
Logical value indicating if the child class is child of the given parent class
Top

PUBLIC ClearCaches ()
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
Purpose: Clears all caches of this class
Notes:

Top

PUBLIC 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
The method allows changing the object type to a sub-type and the module when
the relevant arguments of the parameter object are set

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

PUBLIC Consultingwerk.Framework.Collections.CharacterList CreateDataFields (handle, character, IOverwritePromptCallback)
Purpose: Creates MetaEntityTable, MetaDataField and MetaCalculatedField
object masters for the given Business Entity Model
Notes:

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

PUBLIC 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

PUBLIC 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 of the page to create the instance on
piObjectSequence INTEGER
The sequence of the object instance on the given page
Returns CHARACTER
The Object Instance Guid
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC HANDLE GetAttributeBuffer (character, character, handle)
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
Purpose: Returns a buffer to the attribute of a given object master (when
pcInstanceName is empty) or named object instance
Notes: This instance creates a new (dynamic) buffer. The caller is
responsible for deleting the buffer

Parameters:
pcInstanceName CHARACTER
The name of the instance to return the attribute buffer for, or "" or ? to return the attributes of the master
pcContainerObjectMasterGuid CHARACTER
The GUID of the ContainerObjectMaster
phRepositoryData HANDLE
The handle of the repository data ProDataset
Returns HANDLE
The handle of the attribute buffer
Top

PUBLIC HANDLE GetAttributeBuffer (character, handle)
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
Purpose: Returns a buffer to the attribute of a given object master (when
pcInstanceName is empty) or named object instance
Notes: This instance creates a new (dynamic) buffer. The caller is
responsible for deleting the buffer

Parameters:
pcInstanceName CHARACTER
The name of the instance to return the attribute buffer for, or "" or ? to return the attributes of the master
phRepositoryData HANDLE
The handle of the repository data ProDataset
Returns HANDLE
The handle of the attribute buffer
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC LONGCHAR GetHtmlField (character, character, character, character, character, logical, logical, handle, character, ViewerBindingStyleEnum)
Purpose: Renders a repository field as html
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
pcFieldModel CHARACTER
The model to bind the field to
pcFieldId CHARACTER
The Id of the field (JQuery)
pcFieldName CHARACTER
The value for the html name attribute
plMandatory LOGICAL
Logical value indicating if the field is mandatory
plReadOnly LOGICAL
Logical value indicating if the field is mandatory
phDataset HANDLE
The handle of the Business Entity Dataset
pcTables CHARACTER
The list of tables (entity table + entity view)
poBindingStyle Consultingwerk.Web2.Services.SmartViews.ViewerBindingStyleEnum
The style of data bindings (AngularJS or Angular2)
Returns LONGCHAR
The longchar representation (HTML code) of the field
Top

PUBLIC LONGCHAR GetHtmlField (character, character, character, character, character, logical, logical, handle, character, ViewerBindingStyleEnum, handle)
Purpose: Renders a repository field as html
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
pcFieldId CHARACTER
The Id of the field (JQuery)
pcFieldName CHARACTER
The value for the html name attribute
plMandatory LOGICAL
Logical value indicating if the field is mandatory
plReadOnly LOGICAL
Logical value indicating if the field is mandatory
phDataset HANDLE
The handle of the Business Entity Dataset
pcTables CHARACTER
The list of tables (entity table + entity view)
poBindingStyle Consultingwerk.Web2.Services.SmartViews.ViewerBindingStyleEnum
The style of data bindings (AngularJS or Angular2)
phAttributesBuffer HANDLE
The buffer with the attributes of the object
Returns LONGCHAR
The longchar representation (HTML code) of the field
Top

PUBLIC 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
pcFieldModel CHARACTER
The model to bind the field to
pcFieldName CHARACTER
The value for the html name attribute
plMandatory LOGICAL
Logical value indicating if the field is mandatory
plReadOnly LOGICAL
Logical value indicating if the field is read-only
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

PUBLIC 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 html name attribute
plMandatory LOGICAL
Logical value indicating if the field is mandatory
plReadOnly LOGICAL
Logical value indicating if the field is read-only
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

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

PUBLIC SmartBusinessEntityLookupDescriptor GetLookupDescriptor (character)
Inherited from Consultingwerk.SmartFramework.Repository.ISmartRepositoryClientService
Purpose: Returns a SmartBusinessEntityLookupDescriptor for the repository
Notes:

Parameters:
pcLookupMasterName CHARACTER
The name of the SmartBusinessEntityLookup master
Returns SmartBusinessEntityLookupDescriptor
The SmartBusinessEntityLookupDescriptor instance
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC CHARACTER GetObjectMasterGuidFromInstanceGuid (character, logical)
Purpose: Returns the Object Master Guid based on an Object Master Name
or an object master 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC CHARACTER GetObjectTypeName (character)
Purpose: Returns the Object Type Name 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 Name
Top

PUBLIC 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 (not including the child class)
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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
pcLinkName 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 valid
Top

PUBLIC 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

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

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

PUBLIC ReplaceObjectInstance (character, character)
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
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

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

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


Event Detail
Top

PUBLIC 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


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 18:51:48