Consultingwerk.SmartFramework.Repository.RepositoryEventCatalogService

Namespace:

Consultingwerk.SmartFramework.Repository

Class

RepositoryEventCatalogService

Parent classes:

Progress.Lang.Object

Consultingwerk.SmartFramework.Repository.RepositoryEventCatalogService

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.SmartFramework.Repository.IRepositoryEventCatalogService

Top Method Summary

	Options	Name	Purpose
		EnsureCatalog ()	Loads the catalog resource when it has not been loaded yet
		Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor FindEvent (character, character, character, logical)	Returns the catalog entry matching the object type and event name
		Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor FindUniqueEventName (character, character, logical)	Returns the catalog entry with the given event name when the name is unique among the entries of the requested container scope
		Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor GetEvent (character, character)	Returns the catalog entry for the given object type and event
		Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor GetEvent (character, character, character)	Returns the catalog entry for the given object type and event of an instance in the given container object type
		Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor GetEvents ()	Returns all entries of the event catalog
		LOGICAL IsClientSideSupported (character, character)	Returns if the event can be handled by a method of the Logic Object
		LOGICAL IsClientSideSupported (character, character, character)	Returns if the event of an instance in the given container object type can be handled by a method of the Logic Object
		LOGICAL IsEvent (character, character)	Returns if the given event is described by the catalog
		LOGICAL IsServerSideSupported (character, character, character, RepositoryFrontendEnum)	Returns if the event of an instance in the given container object type is dispatched to a server-side event handler
		LOGICAL IsServerSideSupported (character, character, RepositoryFrontendEnum)	Returns if the event is dispatched to a server-side event handler

Top Constructor Summary

	Options	Name	Purpose
		RepositoryEventCatalogService ()	Constructor for the RepositoryEventCatalogService class

Method Detail

Top

EnsureCatalog ()

Purpose:	Loads the catalog resource when it has not been loaded yet
Notes:

Top

Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor FindEvent (character, character, character, logical)

Purpose:	Returns the catalog entry matching the object type and event name
Notes:	SCL-6074

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
pcContainerType	CHARACTER
	The object type of the container of the instance
plContainerSpecific	LOGICAL
	Return only entries restricted to the container (true) or only entries without a container restriction (false)
Returns	Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
	The matching RepositoryEventDescriptor or ?

Top

Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor FindUniqueEventName (character, character, logical)

Purpose:	Returns the catalog entry with the given event name when the name is
	unique among the entries of the requested container scope
Notes:	SCL-6074. The entries restricted to a container and the entries without
	a container restriction are counted separately, so the grid column
	entries do not break the resolution of the inherited viewer field events

Parameters:
pcEventName	CHARACTER
	The name of the event
pcContainerType	CHARACTER
	The object type of the container of the instance
plContainerSpecific	LOGICAL
	Count only entries restricted to the container (true) or only entries without a container restriction (false)
Returns	Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
	The RepositoryEventDescriptor or ? when the name is not unique

Top

Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor GetEvent (character, character)

Purpose:	Returns the catalog entry for the given object type and event
Notes:	Returns the unknown value when the event is not in the catalog

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
Returns	Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
	The RepositoryEventDescriptor of the event or ? when not in the catalog

Top

Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor GetEvent (character, character, character)

Purpose:	Returns the catalog entry for the given object type and event of an
	instance in the given container object type
Notes:	SCL-6074. An entry restricted to the container object type (containerTypes)
	takes precedence over the entry without a container restriction, e.g. the
	Leave event of a MetaDataField instance in a MetaGrid (a grid column)
	resolves to the entry forwarded by the SmartDataBrowserLogic. Returns the
	unknown value when the event is not in the catalog

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
pcContainerType	CHARACTER
	The object type of the container of the instance, empty for an object master or when unknown
Returns	Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
	The RepositoryEventDescriptor of the event or ? when not in the catalog

Top

Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor GetEvents ()

Purpose:	Returns all entries of the event catalog
Notes:

Returns	Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
	The RepositoryEventDescriptor instances of the catalog

Top

LOGICAL IsClientSideSupported (character, character)

Purpose:	Returns if the event can be handled by a method of the Logic Object
Notes:	False for events that are not routed through the Logic Object

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
Returns	LOGICAL
	Logical value indicating if a client-side handler method is supported

Top

LOGICAL IsClientSideSupported (character, character, character)

Purpose:	Returns if the event of an instance in the given container object type
	can be handled by a method of the Logic Object
Notes:	SCL-6074. False for events that are not routed through the Logic Object

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
pcContainerType	CHARACTER
	The object type of the container of the instance, empty for an object master or when unknown
Returns	LOGICAL
	Logical value indicating if a client-side handler method is supported

Top

LOGICAL IsEvent (character, character)

Purpose:	Returns if the given event is described by the catalog
Notes:

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
Returns	LOGICAL
	Logical value indicating if the event is in the catalog

Top

LOGICAL IsServerSideSupported (character, character, character, RepositoryFrontendEnum)

Purpose:	Returns if the event of an instance in the given container object type
	is dispatched to a server-side event handler
Notes:	SCL-6074

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
pcContainerType	CHARACTER
	The object type of the container of the instance, empty for an object master or when unknown
poFrontend	Consultingwerk.SmartFramework.Repository.RepositoryFrontendEnum
	The frontend to test the server-side support for
Returns	LOGICAL
	Logical value indicating if the frontend dispatches the event server-side

Top

LOGICAL IsServerSideSupported (character, character, RepositoryFrontendEnum)

Purpose:	Returns if the event is dispatched to a server-side event handler
Notes:

Parameters:
pcObjectType	CHARACTER
	The name of the repository object type
pcEventName	CHARACTER
	The name of the event
poFrontend	Consultingwerk.SmartFramework.Repository.RepositoryFrontendEnum
	The frontend to test the server-side support for
Returns	LOGICAL
	Logical value indicating if the frontend dispatches the event server-side

Constructor Detail

Top

RepositoryEventCatalogService ()

Purpose:	Constructor for the RepositoryEventCatalogService class
Notes:

info@consultingwerk.de http://www.consultingwerk.de 09.11.2026 08:11:52