Namespace: Consultingwerk.OERA.RestResource
Class 
RestAnnotationHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.RestResource.RestAnnotationHelper

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetParameterSchemaAnnotations (ListSerializableAnnotation) Returns the annotations of a list that declare a dataset schema
Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetRestAddressAnnotations (ListSerializableAnnotation) Returns the annotations of a list that declare a REST address
Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetRestMethodAnnotations (ListSerializableAnnotation) Returns the annotations of a list that declare a REST method
Consultingwerk.OERA.RestResource.RestAddressTypeEnum GetStrongTypedAddressType (SerializableAnnotation) Returns the address type declared by a strongly typed annotation
LOGICAL HasStrongTypedAnnotation (ListSerializableAnnotation) Returns if a list contains a strongly typed annotation
LOGICAL HasStrongTypedRestAnnotation (ClassAnnotationContainer) Returns if the annotation container holds a strongly typed REST annotation on the class or on one of its methods
LOGICAL IsCollectionAddress (SerializableAnnotation) Returns if the annotation declares a collection address
LOGICAL IsNumberedType (character, character) Returns if an annotation name is one of the numbered variants of an annotation type
LOGICAL IsParameterSchemaAnnotation (SerializableAnnotation) Returns if the annotation declares a dataset schema
LOGICAL IsRestAddressAnnotation (SerializableAnnotation) Returns if the annotation declares a REST address
LOGICAL IsRestMethodAnnotation (SerializableAnnotation) Returns if the annotation declares a REST method


Method Detail
Top

Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetParameterSchemaAnnotations (ListSerializableAnnotation)
Purpose: Returns the annotations of a list that declare a dataset schema
Notes: @ParameterSchema and the ParameterSchema annotation types

Parameters:
poAnnotations Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
The list of annotations
Returns Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
The new list with the matching annotations, empty when the list is not valid
Top

Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetRestAddressAnnotations (ListSerializableAnnotation)
Purpose: Returns the annotations of a list that declare a REST address
Notes: @RestAddress and the Record and Collection annotation types

Parameters:
poAnnotations Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
The list of annotations
Returns Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
The new list with the matching annotations, empty when the list is not valid
Top

Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetRestMethodAnnotations (ListSerializableAnnotation)
Purpose: Returns the annotations of a list that declare a REST method
Notes: @RestMethod and the Method annotation types

Parameters:
poAnnotations Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
The list of annotations
Returns Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
The new list with the matching annotations, empty when the list is not valid
Top

Consultingwerk.OERA.RestResource.RestAddressTypeEnum GetStrongTypedAddressType (SerializableAnnotation)
Purpose: Returns the address type declared by a strongly typed annotation
Notes: The type of a strongly typed REST address follows from its
annotation type, it has no Type property

Parameters:
poAnnotation Consultingwerk.Framework.TypeDescriptor.SerializableAnnotation
The strongly typed annotation
Returns Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The RestAddressTypeEnum member, ? when the annotation is no strongly typed REST address
Top

LOGICAL HasStrongTypedAnnotation (ListSerializableAnnotation)
Purpose: Returns if a list contains a strongly typed annotation
Notes:

Parameters:
poAnnotations Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
The list of annotations
Returns LOGICAL
Logical value indicating if the list contains a strongly typed annotation
Top

LOGICAL HasStrongTypedRestAnnotation (ClassAnnotationContainer)
Purpose: Returns if the annotation container holds a strongly typed REST
annotation on the class or on one of its methods
Notes: Identifies the REST classes that have no .annotations file

Parameters:
poContainer Consultingwerk.Framework.TypeDescriptor.ClassAnnotationContainer
The annotations of a class
Returns LOGICAL
Logical value indicating if a strongly typed REST annotation exists
Top

LOGICAL IsCollectionAddress (SerializableAnnotation)
Purpose: Returns if the annotation declares a collection address
Notes: The Collection annotation types or @RestAddress (type="collection")

Parameters:
poAnnotation Consultingwerk.Framework.TypeDescriptor.SerializableAnnotation
The annotation
Returns LOGICAL
Logical value indicating if the annotation declares a collection address
Top

LOGICAL IsNumberedType (character, character)
Purpose: Returns if an annotation name is one of the numbered variants of
an annotation type
Notes: The type itself and the type followed by 1 to 5

Parameters:
pcAnnotationName CHARACTER
The name of the annotation
pcBaseType CHARACTER
The name of the unnumbered annotation type
Returns LOGICAL
Logical value indicating if the name is a variant of the annotation type
Top

LOGICAL IsParameterSchemaAnnotation (SerializableAnnotation)
Purpose: Returns if the annotation declares a dataset schema
Notes:

Parameters:
poAnnotation Consultingwerk.Framework.TypeDescriptor.SerializableAnnotation
The annotation
Returns LOGICAL
Logical value indicating if the annotation declares a dataset schema
Top

LOGICAL IsRestAddressAnnotation (SerializableAnnotation)
Purpose: Returns if the annotation declares a REST address
Notes:

Parameters:
poAnnotation Consultingwerk.Framework.TypeDescriptor.SerializableAnnotation
The annotation
Returns LOGICAL
Logical value indicating if the annotation declares a REST address
Top

LOGICAL IsRestMethodAnnotation (SerializableAnnotation)
Purpose: Returns if the annotation declares a REST method
Notes:

Parameters:
poAnnotation Consultingwerk.Framework.TypeDescriptor.SerializableAnnotation
The annotation
Returns LOGICAL
Logical value indicating if the annotation declares a REST method


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:06:14