|
Options |
Name |
Purpose |
|
|
|
Progress.Json.ObjectModel.JsonObject CreateLink (character, character, character, character)
|
Creates a link between two object instances or to/from the container
Notes : An empty source or target instance denotes the container itself
@param pcObjectMaster The Object Master Name or GUID of the container holding the link (required unless an instance is specified by its GUID)
@param pcSourceObjectInstance The Object Instance Name or GUID of the link source, empty when the link source is the container
@param pcTargetObjectInstance The Object Instance Name or GUID of the link target, empty when the link target is the container
@param pcLink The name of the link type (e.g. Data, TableIO, Navigation)
@return JsonObject with the created link information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject CreateObjectInstance (character, character, character, character, character, JsonObject)
|
Creates an object instance in a container object master
Notes : When the instance name is empty the instance object master's name is
used; for MetaDataField (or inherited) masters only the last part of
the field name is used. A duplicate instance name is rejected
@param pcContainerObjectMaster The Object Master Name or GUID of the container (required)
@param pcInstanceObjectMaster The Object Master Name or GUID of the object master to create an instance of (required)
@param pcInstanceName The name for the new instance (optional)
@param pcParentInstance The Instance Name or GUID of the parent of the new instance (optional)
@param pcPage The PageKey or page number of the page to add the instance to (optional, MetaForm / MetaControlGroup containers only)
@param poAttributes The JsonObject with initial attribute values (optional)
@return JsonObject with the created instance information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject CreateObjectMaster (character, character, character, character, JsonObject)
|
Creates a new object master (typically a MetaForm, MetaControlGroup
or derived)
Notes : The attributes object is keyed by attribute name with the value in the
matching JSON type (string, number, boolean). A duplicate object
master name is rejected
@param pcObjectMasterName The name for the new Object Master (required)
@param pcObjectType The name or GUID of the object type of the new Object Master, e.g. MetaForm or MetaControlGroup (required)
@param pcProductModule The name or GUID of the product module to add the master to (required)
@param pcDescription The description of the new Object Master (optional)
@param poAttributes The JsonObject with initial attribute values (optional)
@return JsonObject with the created object master information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject CreatePage (character, integer, character, character, character, character, character)
|
Creates a page in an object master
Notes : Only applicable when the container is a MetaForm or MetaControlGroup
(or derived). A duplicate page number or page key is rejected
@param pcObjectMaster The Object Master Name or GUID to add the page to (required)
@param piPageNumber The number of the page to create (required)
@param pcPageKey The key of the page to create (optional, but strongly advised)
@param pcPageLabel The label of the page to create (required)
@param pcTabGroup The tab group the page belongs to (optional)
@param pcPageIcon The PNG image for the Desktop, relative path (optional)
@param pcPageIconWeb The font based icon or relative PNG file name for the Web (optional)
@return JsonObject with the created page information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject DeleteLink (character, character, character, character)
|
Deletes a link between two object instances or to/from the container
Notes : An empty source or target instance denotes the container itself
@param pcObjectMaster The Object Master Name or GUID of the container holding the link (required unless an instance is specified by its GUID)
@param pcSourceObjectInstance The Object Instance Name or GUID of the source of the link to delete, empty when the link source is the container
@param pcTargetObjectInstance The Object Instance Name or GUID of the target of the link to delete, empty when the link target is the container
@param pcLink The name of the link type of the link to delete (e.g. Data, TableIO, Navigation)
@return JsonObject with the deleted link information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject DeleteObjectInstance (character, character)
|
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
@param pcObjectMaster The Object Master Name or GUID of the container (required unless the instance is specified by its GUID)
@param pcObjectInstance The Object Instance Name or GUID to delete (required)
@return JsonObject with the deleted instance information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject DeletePage (character, integer)
|
Deletes an existing page of an object master
Notes : The object instances placed on the page are cascade-deleted
together with the page, including their child instances, links
and attribute values
@param pcObjectMaster The Object Master Name or GUID that the page belongs to (required)
@param piPageNumber The number of the page to delete (required)
@return JsonObject with the deleted page information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetDataSourceFields (character)
|
Returns details about a repository data source and its fields
Notes : The result contains the IDataSourceInfo properties and a field map keyed by short field name
@param pcDataSourceName The data source name to inspect
@return JsonObject containing data source details and field metadata
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetRepositoryAttributeDetails ()
|
Returns repository attribute details for all attributes
Notes : Reads all records from the AttributeBusinessEntity
@return JsonObject containing one entry per repository attribute
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetRepositoryInstanceEvents (character, character)
|
Returns the events registered against the object type of an instance
Notes : Events are repository attributes with the PropertyOrEvent flag set to
false. The result is keyed by event name; the value of each entry is the
registered event handler (a string), or null when no handler is registered.
@param pcContainerName The name of the container (form or viewer) holding the instance
@param pcInstanceName The name of the instance inside the container
@return JsonObject keyed by event name with the registered event handler value
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetRepositoryObject (character)
|
Returns details about a repository object master
Notes : Uses ObjectMasterDatasetModel and enriches the result with design-time attributes and events
@param pcObjectName The object name to load
@return JsonObject containing object details
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject MoveObjectInstance (character, character, character)
|
Moves an object instance to another parent instance within a container
Notes : An empty parent instance moves the instance to the top level
@param pcObjectMaster The Object Master Name or GUID of the container (required unless the instance is specified by its GUID)
@param pcObjectInstance The Object Instance Name or GUID to move (required)
@param pcParentInstance The Instance Name or GUID of the new parent instance, empty for top level
@return JsonObject with the moved instance information
*/
|
|
|
|
CHARACTER SetRepositoryInstanceEvent (character, character, character, character, character)
|
Registers a server-side event handler for an event of an instance
Notes : The event handler value is stored as 'server:<class name>:<method name>`.
When pcHandlerClass is empty the container's ServerSideEventHandler attribute
is used; when pcHandlerClass is provided and the container does not have a
ServerSideEventHandler value yet, it is stored on the container. When
pcMethodName is empty '<Instance Name>@lt;Event Name>Handler' is used.
@param pcContainerName The name of the container (form or viewer) holding the instance
@param pcInstanceName The name of the instance inside the container
@param pcEventName The name of the event to register the handler for
@param pcHandlerClass The name of the server-side event handler class (optional)
@param pcMethodName The name of the event handler method (optional)
@return An informal message describing the registered event handler
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject UpdatePage (character, integer, character, character, character, character, character)
|
Updates an existing page of an object master
Notes : Only the provided (non-empty) values are updated - empty
parameters leave the current value unchanged
@param pcObjectMaster The Object Master Name or GUID that the page belongs to (required)
@param piPageNumber The number of the page to update (required)
@param pcPageKey The key of the page, only updated when provided
@param pcPageLabel The label of the page, only updated when provided
@param pcTabGroup The tab group the page belongs to, only updated when provided
@param pcPageIcon The PNG image for the Desktop, only updated when provided
@param pcPageIconWeb The font based icon or relative PNG file name for the Web, only updated when provided
@return JsonObject with the updated page information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject UpdateRepositoryAttributes (character, character, JsonObject)
|
Updates attributes of an object master or of an object instance
Notes : The attributes object is keyed by attribute name with the value in the
matching JSON type (string, number, boolean); null values reset the
attributes to their inherited values
@param pcObjectMaster The Object Master Name or GUID (required unless the object instance is specified by its Object Instance GUID)
@param pcObjectInstance The Object Instance Name or GUID (required to update object instance attributes, otherwise object master attributes are updated)
@param poAttributes The JsonObject with the attributes to set
@return JsonObject with update result information
*/
|
|
|
|
Progress.Json.ObjectModel.JsonObject UpdateRepositoryObject (JsonObject)
|
Updates or creates a repository object based on an updated JSON structure
Notes : The input JsonObject is expected to match the structure returned by GetRepositoryObject.
@param poObject The updated repository object JSON
@return JsonObject with update result information
*/
|
