| |
Options |
Name |
Purpose |
|
|
|
ApplySchemaOptions (handle, SchemaOption)
|
/** Applies schema-related options (serialize-*) to a table/dataset/child handle
@param handle The buffer/dataset handle to which to apply the option
@param SchemaOption The schema option to apply to the input schema structure */
|
|
|
|
Ccs.Common.Support.IHandleHolder CloneServiceSchema (SchemaOption)
|
/* Clones a service schema
@param SchemaOption The schema option to apply
@return handle A schema handle. UNKNOWN if the schema cannot be found */
|
|
|
|
LOGICAL Equals (Object)
|
|
|
|
|
FindOperationRecord (character, character, buffer)
|
/* Helper method to find and position the Operation buffer (record) to a given service/method.
Caller must check buffer availablity themselves before accessing the MappedOperation which
will be contained within the available buffer. Note: For service URIs which are expected to
be used with tokenized path parameters, this method will attempt to match based on the URI
provided which may be either the URI from the client (with values filled in where tokens
should be) or the URI provided by the WEB transport which would be the URI matched in the
Handlers definition. The latter could have been provided in the openedge.properties file
or via a .handlers file.
@param character The service URI
@param character The http method
@param buffer The Operation record to find. */
|
|
|
|
FindSchemaRecord (character, buffer)
|
/* Helper method to find and position the Service buffer to a given service. Caller must check
availablity themselves.
@param character The schema name
@param buffer The schema record to find. */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (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 An optional name for the operation
@return MappedOperation The operation map for this name */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, MethodEnum)
|
/* Returns details about an operation in this service
@param character The relative URI
@param MethodEnum The HTTP method
@return MappedOperation The operation map for this Method/URI */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperations ()
|
/* Returns an array or operations for the service
@return MappedOperation[] The operations for this service */
|
|
|
|
HANDLE GetSchema (character)
|
/* Returns a named schema for a latest version of a service.
@param character The schema name
@return handle An empty data structure (TT or PDS) */
|
|
|
|
HANDLE GetSchemas ()
|
/* Returns all of the schema names associated with a service .
@return handle[] An array of service schemas */
|
|
|
|
LOGICAL HasOperation (character)
|
/* Indicates whether a mapped operation exists with a given name
@param character The operation name
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasOperation (character, MethodEnum)
|
/* Indicates whether a mapped operation exists for this service
@param character The relative URI (to the service)
@param MethodEnum The HTTP method
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasSchema (character)
|
/* Indicates whether a mapped operation exists with a given name
@param character The operation name
@return logical TRUE if the service exists */
|
|
|
|
Merge (DataObjectService)
|
/* Merges service information into this one. The source of the
merge data must have the same name and version, otherwise
an error is thrown.
A Merge will overwrite the schemas, operations, catalogs and
argument writers in this object with those that are passed in
(the source service).
If there are schemas, operations and argument writers in the
source service that are not in this service, they will be added.
If there are schemas, operations and argument writers in the
THIS service that are not in the source service, they will be
not be touched.
@param DataObjectService A service to merge into this one. */
|
|
|
|
CHARACTER NormaliseServiceName (character)
|
/* Makes sure the service name is 'nice' and clean.
This is a deprecated method name using older spelling.
@param character A service name that may be empty or have /'s
@return character A non-slashed, non-empty name */
|
|
|
|
CHARACTER NormalizeServiceName (character)
|
/* Makes sure the service name is 'nice' and clean.
@param character A service name that may be empty or have /'s
@return character A non-slashed, non-empty name */
|
|
|
|
LOGICAL PutOperation (MappedOperation)
|
/* Adds a new operation map for a service.
@param MappedOperation The operation map for this Method/URI
@return logical TRUE if the operation already exists. */
|
|
|
|
LOGICAL PutSchema (character, handle)
|
/* Saves a schema for a given service.
@param character The schema name
@param handle An empty data structure (TT or PDS)
@return logical TRUE if the schema already exists. */
|
|
|
|
RemoveOperation (character, MethodEnum)
|
/* Removes an operation mapping from the collection operation maps.
No-op if none exists.
@param character The relative URI
@param MethodEnum The HTTP method */
|
|
|
|
RemoveSchema (character)
|
/* Removes a schema from service
No-op if none exists.
@param character The schema name */
|
|
|
|
CHARACTER ToString ()
|
|