|
Options |
Name |
Purpose |
|
|
|
DeregisterService (character, SemanticVersion)
|
/* Removes a service registration. No-op of the service + version is not
registered.
@param character The name of the service to remove from the registry
@param SemanticVersion The version to deregister */
|
|
|
|
FindServiceLatest (character, SemanticVersion, buffer)
|
/* Helper method to find and position the Service buffer to the latest version of a given service.
Caller must check availablity themselves.
@param character The service name (normalised - no-/, not-empty)
@param SemanticVersion The service version to start at. If none, start at v0.0.0
@param buffer The Service record to find. */
|
|
|
|
FindServiceRecord (character, SemanticVersion, buffer)
|
/* Helper method to find and position the Service buffer to a given service+version. Caller must check
availablity themselves.
For unknown/unsure versions, use FindServiceLatest()
@param character The service name
@param SemanticVersion The service version
@param buffer The Service record to find. */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, character)
|
/* Returns details about the operation, for a service by name. If more than one
operation exists with the same name, pick the first.
@param character The service name
@param character An optional name for the operation
@return MappedOperation The operation map for this name */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, character, MethodEnum)
|
/* Returns details about the operation
@param character The serviceName
@param character The relative URI
@param MethodEnum The HTTP method
@return MappedOperation The operation map for this Method/URI */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, SemanticVersion, character)
|
/* Returns details about the operation, for a service by name. If more than one
operation exists with the same name, pick the first.
@param character The service name
@param SemanticVersion The service version
@param character An optional name for the operation
@return MappedOperation The operation map for this name */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, SemanticVersion, character, MethodEnum)
|
/* Returns details about the operation
@param character The serviceName
@param SemanticVersion The service version
@param character The relative URI
@param MethodEnum The HTTP method
@return MappedOperation The operation map for this Method/URI */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperations (character, SemanticVersion)
|
/* Returns an array or operations for the service
@param character The serviceName
@param SemanticVersion The service version
@return MappedOperation[] The operations for this service */
|
|
|
|
HANDLE GetSchema (character, character)
|
/* Returns a named schema for a latest version of a service.
@param character The service name
@param character The schema name
@return handle An empty data structure (TT or PDS) */
|
|
|
|
HANDLE GetSchema (character, SemanticVersion, character)
|
/* Returns a schema for a given service oepration.
@param character The service name
@param SemanticVersion The service version
@param character The schema name
@return handle An empty data structure (TT or PDS) */
|
|
|
|
HANDLE GetSchemas (character, SemanticVersion)
|
/* Returns all of the schemas associated with the latest version of a service.
@param character The service name
@param SemanticVersion The service version
@return handle[] An array of service schemas */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService GetService (character)
|
/* Returns a the latest version of a service
@param character The name of the service to remove from the registry
@return DataObjectService A data service 'header' */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService GetService (character, character)
|
/* Returns a service object
@param character The name of the service to remove from the registry
@param character The service version to deregister
@return DataObjectService A data service 'header' */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService GetService (character, SemanticVersion)
|
/* Returns a versioned service. If this exact version is not found, then error
@param character The name of the service to find
@param SemanticVersion The service version to retrieve
@return DataObjectService A data service */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetServiceCatalog (character)
|
/* Returns a catalog for a named service
@param character The service name.
@return JsonObject A JSDO catalog. If no exist or none can be found, return null.
@throws AssertionFailedError If the name is empty or null
@throws AppError If the requested service does not exist in the registry */
|
|
|
|
OpenEdge.Web.DataObject.ServiceOptions GetServiceOptions (character)
|
/* Returns the service options for a named service
@param character The service name.
@return ServiceOptions The service options.
@throws AssertionFailedError If the name is empty or null
@throws AppError If the service is not registered */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService GetServices ()
|
/* Returns all registered services
@return DataObjectService[] extent An array of registered services. indeterminate if none. */
|
|
|
|
OpenEdge.Core.SemanticVersion GetServiceVersions (character)
|
/* Returns an array of versions for this service.
@param character The service name
@return SemanticVersion[] An array of service versions. Will always have at least 1 extent
@throws AppError If the service is not registered */
|
|
|
|
LOGICAL HasOperation (character, character)
|
/* Indicates whether a mapped operation exists with a given name
@param character the service name
@param character The operation name
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasOperation (character, character, MethodEnum)
|
/* Indicates whether a mapped operation exists
@param character the service name
@param character The relative URI (to the service)
@param MethodEnum The HTTP method
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasOperation (character, SemanticVersion, character)
|
/* Indicates whether a mapped operation exists with a given name
@param character the service name
@param SemanticVersion The service version
@param character The operation name
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasOperation (character, SemanticVersion, character, MethodEnum)
|
/* Indicates whether a mapped operation exists
@param character the service name
@param SemanticVersion The service version
@param character The relative URI (to the service)
@param MethodEnum The HTTP method
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasSchema (character, character)
|
/* Indicates whether a schema exists with a given name
@param character the service name
@param character The schema name
@return logical TRUE if the schema exists */
|
|
|
|
LOGICAL HasSchema (character, SemanticVersion, character)
|
/* Indicates whether a schema exists with a given name
@param character the service name
@param SemanticVersion The service version
@param character The schema name
@return logical TRUE if the schema exists */
|
|
|
|
LOGICAL HasService (character)
|
/* Indicates whether a named service is available in the registry.
@param character The name of the mapped service
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasService (character, character)
|
/* Indicates whether a named service is available in the registry.
@param character The name of the mapped service
@param character The service version
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasService (character, SemanticVersion)
|
/* Indicates whether a named, versioned service is available in the registry.
@param character The name of the mapped service
@param SemanticVersion The service version
@return logical TRUE if the service exists */
|
|
|
|
OnServiceDeregistered (ServiceRegistryEventArgs)
|
/* Publishes the ServiceDeregistered event
@param ServiceRegistryEventArgs The event args */
|
|
|
|
OnServiceRegistered (ServiceRegistryEventArgs)
|
/* Publishes the ServiceRegistered event
@param ServiceRegistryEventArgs The event args */
|
|
|
|
PutOperation (character, SemanticVersion, MappedOperation)
|
/* Adds a new operation map for a service.
@param character The service name
@param SemanticVersion The service version
@param MappedOperation The operation map for this Method/URI */
|
|
|
|
PutSchema (character, SemanticVersion, character, handle)
|
/* Saves a schema for a given service
@param character The service name
@param SemanticVersion The service version
@param character The schema name
@param handle An empty data structure (TT or PDS) */
|
|
|
|
PutServiceCatalog (character, SemanticVersion, JsonObject)
|
/* Sets a catalog for a named service
@param character The service name.
@param SemanticVersion The service version
@param JsonObject A JSDO catalog. If no exist or none can be found, return null.
@throws AssertionFailedError If the name is empty or null
@throws AppError If the requested service does not exist in the registry */
|
|
|
|
PutServiceOptions (character, SemanticVersion, ServiceOptions)
|
/* Sets the service options for a named service
@param character The service name.
@param SemanticVersion The service version
@param ServiceOptions The service options
@throws AssertionFailedError If the name is empty or null
@throws AppError If the requested service does not exist in the registry */
|
|
|
|
OpenEdge.Web.DataObject.DataObjectService RegisterService (character, SemanticVersion, ServiceOptions, JsonObject)
|
/* Register a service
@param character (mandatory) The service name
@param SemanticVersion (mandatory) The service version
@param ServiceOptions (optional) A set of options for the service
@param JsonObject (optional) A catalog for the service. Not all services have catalogs
@return DataObjectService The (registered) data service */
|
|
|
|
RegisterService (DataObjectService)
|
/* Adds a service to this registry
@param DataObjectService A data service object */
|
|
|
|
RemoveOperation (character, SemanticVersion, character, MethodEnum)
|
/* Removes an operation mapping from the collection operation maps.
No-op if none exists.
@param character the service name
@param SemanticVersion The service version
@param character The relative URI
@param MethodEnum The HTTP method */
|
|
|
|
RemoveSchema (character, SemanticVersion, character)
|
/* Removes an operation schema from service
No-op if none exists.
@param character the service name
@param SemanticVersion The service version
@param character The schema name */
|