Class EndpointModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class EndpointModel
    extends ItemModel
    Generated model class for type Endpoint first defined at extension apiregistryservices.

    Webservice Specification.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of Endpoint.description attribute defined at extension apiregistryservices.
      static java.lang.String DESTINATIONS
      Generated constant - Attribute key of Endpoint.destinations attribute defined at extension apiregistryservices.
      static java.lang.String EXTENSIONNAME
      Generated constant - Attribute key of Endpoint.extensionName attribute defined at extension apiregistryservices.
      static java.lang.String ID
      Generated constant - Attribute key of Endpoint.id attribute defined at extension apiregistryservices.
      static java.lang.String NAME
      Generated constant - Attribute key of Endpoint.name attribute defined at extension apiregistryservices.
      static java.lang.String SPECDATA
      Generated constant - Attribute key of Endpoint.specData attribute defined at extension apiregistryservices.
      static java.lang.String SPECURL
      Generated constant - Attribute key of Endpoint.specUrl attribute defined at extension apiregistryservices.
      static java.lang.String VERSION
      Generated constant - Attribute key of Endpoint.version attribute defined at extension apiregistryservices.
    • Constructor Summary

      Constructors 
      Constructor Description
      EndpointModel()
      Generated constructor - Default constructor for generic creation.
      EndpointModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      EndpointModel​(java.lang.String _id, java.lang.String _name, ItemModel _owner, java.lang.String _version)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      EndpointModel​(java.lang.String _id, java.lang.String _name, java.lang.String _version)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • ID

        public static final java.lang.String ID
        Generated constant - Attribute key of Endpoint.id attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
      • VERSION

        public static final java.lang.String VERSION
        Generated constant - Attribute key of Endpoint.version attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of Endpoint.name attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of Endpoint.description attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
      • SPECURL

        public static final java.lang.String SPECURL
        Generated constant - Attribute key of Endpoint.specUrl attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
      • SPECDATA

        public static final java.lang.String SPECDATA
        Generated constant - Attribute key of Endpoint.specData attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
      • EXTENSIONNAME

        public static final java.lang.String EXTENSIONNAME
        Generated constant - Attribute key of Endpoint.extensionName attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
      • DESTINATIONS

        public static final java.lang.String DESTINATIONS
        Generated constant - Attribute key of Endpoint.destinations attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values
    • Constructor Detail

      • EndpointModel

        public EndpointModel()
        Generated constructor - Default constructor for generic creation.
      • EndpointModel

        public EndpointModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • EndpointModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public EndpointModel​(java.lang.String _id,
                             java.lang.String _name,
                             java.lang.String _version)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _id - initial attribute declared by type Endpoint at extension apiregistryservices
        _name - initial attribute declared by type Endpoint at extension apiregistryservices
        _version - initial attribute declared by type Endpoint at extension apiregistryservices
      • EndpointModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public EndpointModel​(java.lang.String _id,
                             java.lang.String _name,
                             ItemModel _owner,
                             java.lang.String _version)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _id - initial attribute declared by type Endpoint at extension apiregistryservices
        _name - initial attribute declared by type Endpoint at extension apiregistryservices
        _owner - initial attribute declared by type Item at extension core
        _version - initial attribute declared by type Endpoint at extension apiregistryservices
    • Method Detail

      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription()
        Generated method - Getter of the Endpoint.description attribute defined at extension apiregistryservices.
        Returns:
        the description - Short Description
      • getDestinations

        @Accessor(qualifier="destinations",
                  type=GETTER)
        public java.util.Collection<AbstractDestinationModel> getDestinations()
        Generated method - Getter of the Endpoint.destinations attribute defined at extension apiregistryservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the destinations - Destinations
      • getExtensionName

        @Accessor(qualifier="extensionName",
                  type=GETTER)
        public java.lang.String getExtensionName()
        Generated method - Getter of the Endpoint.extensionName attribute defined at extension apiregistryservices.
        Returns:
        the extensionName - Endpoint Extension
      • getId

        @Accessor(qualifier="id",
                  type=GETTER)
        public java.lang.String getId()
        Generated method - Getter of the Endpoint.id attribute defined at extension apiregistryservices.
        Returns:
        the id - Unique Id
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName()
        Generated method - Getter of the Endpoint.name attribute defined at extension apiregistryservices.
        Returns:
        the name - Human-readable Name
      • getSpecData

        @Accessor(qualifier="specData",
                  type=GETTER)
        public java.lang.String getSpecData()
        Generated method - Getter of the Endpoint.specData attribute defined at extension apiregistryservices.
        Returns:
        the specData - Endpoint specification data, in case url is absent
      • getSpecUrl

        @Accessor(qualifier="specUrl",
                  type=GETTER)
        public java.lang.String getSpecUrl()
        Generated method - Getter of the Endpoint.specUrl attribute defined at extension apiregistryservices.
        Returns:
        the specUrl - Endpoint Specification URL
      • getVersion

        @Accessor(qualifier="version",
                  type=GETTER)
        public java.lang.String getVersion()
        Generated method - Getter of the Endpoint.version attribute defined at extension apiregistryservices.
        Returns:
        the version - Endpoint Version
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value)
        Generated method - Setter of Endpoint.description attribute defined at extension apiregistryservices.
        Parameters:
        value - the description - Short Description
      • setDestinations

        @Accessor(qualifier="destinations",
                  type=SETTER)
        public void setDestinations​(java.util.Collection<AbstractDestinationModel> value)
        Generated method - Setter of Endpoint.destinations attribute defined at extension apiregistryservices.
        Parameters:
        value - the destinations - Destinations
      • setExtensionName

        @Accessor(qualifier="extensionName",
                  type=SETTER)
        public void setExtensionName​(java.lang.String value)
        Generated method - Setter of Endpoint.extensionName attribute defined at extension apiregistryservices.
        Parameters:
        value - the extensionName - Endpoint Extension
      • setId

        @Accessor(qualifier="id",
                  type=SETTER)
        public void setId​(java.lang.String value)
        Generated method - Initial setter of Endpoint.id attribute defined at extension apiregistryservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the id - Unique Id
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value)
        Generated method - Setter of Endpoint.name attribute defined at extension apiregistryservices.
        Parameters:
        value - the name - Human-readable Name
      • setSpecData

        @Accessor(qualifier="specData",
                  type=SETTER)
        public void setSpecData​(java.lang.String value)
        Generated method - Setter of Endpoint.specData attribute defined at extension apiregistryservices.
        Parameters:
        value - the specData - Endpoint specification data, in case url is absent
      • setSpecUrl

        @Accessor(qualifier="specUrl",
                  type=SETTER)
        public void setSpecUrl​(java.lang.String value)
        Generated method - Setter of Endpoint.specUrl attribute defined at extension apiregistryservices.
        Parameters:
        value - the specUrl - Endpoint Specification URL
      • setVersion

        @Accessor(qualifier="version",
                  type=SETTER)
        public void setVersion​(java.lang.String value)
        Generated method - Initial setter of Endpoint.version attribute defined at extension apiregistryservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the version - Endpoint Version