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

Inherits: Consultingwerk.JsonSerializable
Implements: Consultingwerk.IJsonSerializable, Consultingwerk.OERA.RestResource.IRestAddress
SERIALIZABLE

File:RestAddress
Purpose:Describes a REST resource address scheme
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jul 23 10:59:44 CEST 2017
Purpose: Gets the Address
Notes:

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



Top Method Summary
Options Name Purpose
# CHARACTER AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
# CHARACTER AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ Deserialize (longchar) Deserializes a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ DeserializeFromJsonObject (JsonObject) Initializes the object instance based on the passed in JsonObject representation of the object instance
Inherited from Consultingwerk.JsonSerializable
# DeserializeProperty (JsonObject, character, character, character) Deserializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
# IEnumerable GetEnumerableInstance (character) Returns an instance of the enumerable type
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER GetSerializeName (character) Returns the SerializeName of a property
Inherited from Consultingwerk.JsonSerializable
# LazyAddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR Serialize () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
# SerializeProperty (JsonObject, character, character, character) Serializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER ToString () Returns a CHARACTER Representation of the RestAddress
+ LONGCHAR WriteJson () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR WriteXml () Returns an XML LONGCHAR representation of the object instance
Inherited from Consultingwerk.JsonSerializable
+ HANDLE XmlSerialize (handle) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.JsonSerializable
+ XmlSerializeProperties (handle) Serializes the properties of this object instance as child nodes of the given node
Inherited from Consultingwerk.JsonSerializable
# XmlSerializeProperty (handle, character, character) Serializes a single property value to the current parent XmlNode
Inherited from Consultingwerk.JsonSerializable

Top Constructor Summary
Options Name Purpose
+ RestAddress () Constructor for the RestMethod class
+ RestAddress (character, RestAddressTypeEnum, character, character, character) Constructor for the RestAddress class
+ RestAddress (character, RestAddressTypeEnum, character, character, character, character) Constructor for the RestAddress class
+ RestAddress (character, RestAddressTypeEnum, character, character, character, character, character) Constructor for the RestAddress class
+ RestAddress (character, RestAddressTypeEnum, character, character, character, character, character, character, logical, logical, logical, logical) Constructor for the RestAddress class
+ RestAddress (character, RestAddressTypeEnum, character, character, character, character, character, character, logical, logical, logical, logical, character, character) Constructor for the RestAddress class
+ RestAddress (character, RestAddressTypeEnum, character, character, character, character, character, character, logical, logical, logical, logical, character, character, character, character, character, character, character, character) Constructor for the RestAddress class
+ RestAddress (character, RestAddressTypeEnum, character, character, character, logical, logical, logical, logical) Constructor for the RestAddress class
+ RestAddress (SerializableAnnotation, character) Constructor for the RestAddress class

Top Property Summary
Options Name Purpose
+ CHARACTER Address
+ LOGICAL CanCreate
+ LOGICAL CanDelete
+ LOGICAL CanRead
+ LOGICAL CanUpdate
+ CHARACTER ChildAddresses
+ CHARACTER EntityName
+ CHARACTER Fields
+ CHARACTER Id
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER Links
+ CHARACTER MethodDescriptionDelete
+ CHARACTER MethodDescriptionGet
+ CHARACTER MethodDescriptionPatch
+ CHARACTER MethodDescriptionPost
+ CHARACTER MethodDescriptionPut
+ CHARACTER NamedQuery
+ CHARACTER NamedQueryParameters
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
# CHARACTER SerializeNames
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER Tables
+ CHARACTER Tags
+ Consultingwerk.OERA.RestResource.RestAddressTypeEnum Type
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED CHARACTER AddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Returns CHARACTER
The value of the SerializableProperties property
Top

PROTECTED AddSerializableProperties (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Add a list of Serializable Properties to the SerializableProperties property
Notes: Required as a workaround to full reflection only. We *may* remove this
method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties CHARACTER
A comma delimited list of serializable properties
Top

PROTECTED CHARACTER AddSerializableProperties (Class)
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the given class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Parameters:
poClass Progress.Lang.Class
The declaring class
Returns CHARACTER
The value of the SerializableProperties property
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedRepresentation LONGCHAR
The stored LONGCHAR representation of the objects data
Top

PUBLIC DeserializeFromJsonObject (JsonObject)
Inherited from Consultingwerk.JsonSerializable
Purpose: Initializes the object instance based on the passed in JsonObject
representation of the object instance
Notes:

Parameters:
poJsonObject JsonObject
The stored JsonObject representation of the objects data
Top

PROTECTED DeserializeProperty (JsonObject, character, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization
Notes:

Parameters:
poJsonObject JsonObject
The reference to the source JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PROTECTED IEnumerable GetEnumerableInstance (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an instance of the enumerable type
Notes: When the property value is referencing a value list instance, this
instance is returned. If not, we attempt to create a new instance

Parameters:
pcProperty CHARACTER
The name of the List property
Returns IEnumerable
The instance of the enumerable type
Top

PUBLIC CHARACTER GetSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns the meta data of the serializable properties
Notes:

Returns CHARACTER
The serializable properties meta data as a comma delimited list
Top

PUBLIC CHARACTER GetSerializeName (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns the SerializeName of a property
Notes: See property SerializeNames for details

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns CHARACTER
The SerializeName of the property
Top

PROTECTED LazyAddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes:

Top

PUBLIC LONGCHAR Serialize ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PROTECTED SerializeProperty (JsonObject, character, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization

Parameters:
poJsonObject JsonObject
The reference to the target JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a JsonObject representation of the state of the class instance
Notes: Returns the classname together with the Json serialization of the
object

Returns Progress.Json.ObjectModel.JsonObject
The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data
Top

PUBLIC CHARACTER ToString ()
Purpose: Returns a CHARACTER Representation of the RestAddress
Notes:

Returns CHARACTER
The CHARACTER Representation of the RestAddress
Top

PUBLIC LONGCHAR WriteJson ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization
This method is a facade to the JsonSerializable:Serialize method

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC LONGCHAR WriteXml ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an XML LONGCHAR representation of the object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC HANDLE XmlSerialize (handle)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of the current object instance to
an existing X-NODEREF object
Notes:

Parameters:
phParent HANDLE
The reference to the parent XML Node or Document
Returns HANDLE
The X-NODEREF with the properties of the serialized object
Top

PUBLIC XmlSerializeProperties (handle)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of this object instance as child nodes of
the given node
Notes:

Parameters:
phObjectNode HANDLE
The reference to the X-NODEREF object that represents the node for the current instance
Top

PROTECTED XmlSerializeProperty (handle, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current parent XmlNode
Notes: Allows to override the handling of individual properties during the
XmlSerialization

Parameters:
phParentNode HANDLE
The reference to the parent XML Node
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property


Constructor Detail
Top

PUBLIC RestAddress ()
Purpose: Constructor for the RestMethod class
Notes:

Top

PUBLIC RestAddress (character, RestAddressTypeEnum, character, character, character)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
pcAddress CHARACTER
The Address value
poType Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The Type value
pcEntityName CHARACTER
The EntityName value
pcTables CHARACTER
The tables value
pcId CHARACTER
The Id value
Top

PUBLIC RestAddress (character, RestAddressTypeEnum, character, character, character, character)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
pcAddress CHARACTER
The Address value
poType Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The Type value
pcEntityName CHARACTER
The EntityName value
pcTables CHARACTER
The tables value
pcId CHARACTER
The Id value
pcFields CHARACTER
The Fields value
Top

PUBLIC RestAddress (character, RestAddressTypeEnum, character, character, character, character, character)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
pcAddress CHARACTER
The Address value
poType Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The Type value
pcEntityName CHARACTER
The EntityName value
pcTables CHARACTER
The tables value
pcId CHARACTER
The Id value
pcFields CHARACTER
The Fields value
pcChildAddresses CHARACTER
The child address values
Top

PUBLIC RestAddress (character, RestAddressTypeEnum, character, character, character, character, character, character, logical, logical, logical, logical)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
pcAddress CHARACTER
The Address value
poType Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The Type value
pcEntityName CHARACTER
The EntityName value
pcTables CHARACTER
The tables value
pcId CHARACTER
The Id value
pcFields CHARACTER
The Fields value
pcChildAddresses CHARACTER
The child address values
pcLinks CHARACTER
The links value
plCanRead LOGICAL
The CanRead value
plCanUpdate LOGICAL
The CanUpdate value
plCanCreate LOGICAL
The CanCreate value
plCanDelete LOGICAL
The CanDelete value
Top

PUBLIC RestAddress (character, RestAddressTypeEnum, character, character, character, character, character, character, logical, logical, logical, logical, character, character)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
pcAddress CHARACTER
The Address value
poType Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The Type value
pcEntityName CHARACTER
The EntityName value
pcTables CHARACTER
The tables value
pcId CHARACTER
The Id value
pcFields CHARACTER
The Fields value
pcChildAddresses CHARACTER
The child address values
pcLinks CHARACTER
The links value
plCanRead LOGICAL
The CanRead value
plCanUpdate LOGICAL
The CanUpdate value
plCanCreate LOGICAL
The CanCreate value
plCanDelete LOGICAL
The CanDelete value
pcNamedQuery CHARACTER
The named query
pcNamedQueryParameter CHARACTER
Named query parameters
Top

PUBLIC RestAddress (character, RestAddressTypeEnum, character, character, character, character, character, character, logical, logical, logical, logical, character, character, character, character, character, character, character, character)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
pcAddress CHARACTER
The Address value
poType Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The Type value
pcEntityName CHARACTER
The EntityName value
pcTables CHARACTER
The tables value
pcId CHARACTER
The Id value
pcFields CHARACTER
The Fields value
pcChildAddresses CHARACTER
The child address values
pcLinks CHARACTER
The links value
plCanRead LOGICAL
The CanRead value
plCanUpdate LOGICAL
The CanUpdate value
plCanCreate LOGICAL
The CanCreate value
plCanDelete LOGICAL
The CanDelete value
pcNamedQuery CHARACTER
The named query
pcNamedQueryParameter CHARACTER
Named query parameters
pcTags CHARACTER
The Swagger tags for this address
pcMethodDescriptionGet CHARACTER
The Swagger description for GET requests to this address
pcMethodDescriptionPut CHARACTER
The Swagger description for PUT requests to this address
pcMethodDescriptionPost CHARACTER
The Swagger description for POST requests to this address
pcMethodDescriptionPatch CHARACTER
The Swagger description for PATCH requests to this address
pcMethodDescriptionDelete CHARACTER
The Swagger description for DELETE requests to this address
Top

PUBLIC RestAddress (character, RestAddressTypeEnum, character, character, character, logical, logical, logical, logical)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
pcAddress CHARACTER
The Address value
poType Consultingwerk.OERA.RestResource.RestAddressTypeEnum
The Type value
pcEntityName CHARACTER
The EntityName value
pcTables CHARACTER
The tables value
pcId CHARACTER
The Id value
plCanRead LOGICAL
The CanRead value
plCanUpdate LOGICAL
The CanUpdate value
plCanCreate LOGICAL
The CanCreate value
plCanDelete LOGICAL
The CanDelete value
Top

PUBLIC RestAddress (SerializableAnnotation, character)
Purpose: Constructor for the RestAddress class
Notes:

Parameters:
poAnnotation Consultingwerk.Framework.TypeDescriptor.SerializableAnnotation
The class annotation that provides the information for the REST Address
pcEntityName CHARACTER
The name of the Business Entity


Property Detail
Top

PUBLIC CHARACTER Address

Returns CHARACTER
Top

PUBLIC LOGICAL CanCreate

Returns LOGICAL
Top

PUBLIC LOGICAL CanDelete

Returns LOGICAL
Top

PUBLIC LOGICAL CanRead

Returns LOGICAL
Top

PUBLIC LOGICAL CanUpdate

Returns LOGICAL
Top

PUBLIC CHARACTER ChildAddresses

Returns CHARACTER
Top

PUBLIC CHARACTER EntityName

Returns CHARACTER
Top

PUBLIC CHARACTER Fields

Returns CHARACTER
Top

PUBLIC CHARACTER Id

Returns CHARACTER
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC CHARACTER Links

Returns CHARACTER
Top

PUBLIC CHARACTER MethodDescriptionDelete

Returns CHARACTER
Top

PUBLIC CHARACTER MethodDescriptionGet

Returns CHARACTER
Top

PUBLIC CHARACTER MethodDescriptionPatch

Returns CHARACTER
Top

PUBLIC CHARACTER MethodDescriptionPost

Returns CHARACTER
Top

PUBLIC CHARACTER MethodDescriptionPut

Returns CHARACTER
Top

PUBLIC CHARACTER NamedQuery

Returns CHARACTER
Top

PUBLIC CHARACTER NamedQueryParameters

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PROTECTED CHARACTER SerializeNames
Inherited from Consultingwerk.JsonSerializable

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC CHARACTER Tables

Returns CHARACTER
Top

PUBLIC CHARACTER Tags

Returns CHARACTER
Top

PUBLIC Consultingwerk.OERA.RestResource.RestAddressTypeEnum Type

Returns Consultingwerk.OERA.RestResource.RestAddressTypeEnum
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:00:26