Package org.odpi.openmetadata.frameworks.integration.bitol.common

Class BitolSupportChannel

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.common.BitolSupportChannel
public class BitolSupportChannel extends Object
This class represents a support or communication channel for a Bitol Open Data Contract Standard (ODCS) data contract or Open Data Product Standard (ODPS) data product.

  • Constructor Details

    • BitolSupportChannel

      public BitolSupportChannel()
      Default constructor

  • Method Details

    • getId

      public String getId()
      Return the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
      Returns:
      string identifier

    • setId

      public void setId(String id)
      Set up the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
      Parameters:
      id - string identifier

    • getChannel

      public String getChannel()
      Return the name or identifier of the channel.
      Returns:
      string name

    • setChannel

      public void setChannel(String channel)
      Set up the name or identifier of the channel.
      Parameters:
      channel - string name

    • getUrl

      public String getUrl()
      Return the access URL for the channel (https, mailto, etc).
      Returns:
      string URL

    • setUrl

      public void setUrl(String url)
      Set up the access URL for the channel (https, mailto, etc).
      Parameters:
      url - string URL

    • getDescription

      public String getDescription()
      Return the free text description of the channel.
      Returns:
      string description

    • setDescription

      public void setDescription(String description)
      Set up the free text description of the channel.
      Parameters:
      description - string description

    • getTool

      public String getTool()
      Return the name of the tool that hosts the channel. Standard values are defined in BitolSupportTool.
      Returns:
      string tool name

    • setTool

      public void setTool(String tool)
      Set up the name of the tool that hosts the channel. Standard values are defined in BitolSupportTool.
      Parameters:
      tool - string tool name

    • getScope

      public String getScope()
      Return the scope of the channel. Standard values are defined in BitolSupportScope.
      Returns:
      string scope name

    • setScope

      public void setScope(String scope)
      Set up the scope of the channel. Standard values are defined in BitolSupportScope.
      Parameters:
      scope - string scope name

    • getInvitationUrl

      public String getInvitationUrl()
      Return the URL used to request access to, or subscribe to, the channel.
      Returns:
      string URL

    • setInvitationUrl

      public void setInvitationUrl(String invitationUrl)
      Set up the URL used to request access to, or subscribe to, the channel.
      Parameters:
      invitationUrl - string URL

    • getTags

      public List<String> getTags()
      Return the list of tags attached to this element.
      Returns:
      list of tag strings

    • setTags

      public void setTags(List<String> tags)
      Set up the list of tags attached to this element.
      Parameters:
      tags - list of tag strings

    • getCustomProperties

      public List<BitolCustomProperty> getCustomProperties()
      Return the list of custom (key/value) properties attached to this element.
      Returns:
      list of custom properties

    • setCustomProperties

      public void setCustomProperties(List<BitolCustomProperty> customProperties)
      Set up the list of custom (key/value) properties attached to this element.
      Parameters:
      customProperties - list of custom properties

    • getAuthoritativeDefinitions

      public List<BitolAuthoritativeDefinition> getAuthoritativeDefinitions()
      Return the list of links to sources that provide more details about this element.
      Returns:
      list of authoritative definitions

    • setAuthoritativeDefinitions

      public void setAuthoritativeDefinitions(List<BitolAuthoritativeDefinition> authoritativeDefinitions)
      Set up the list of links to sources that provide more details about this element.
      Parameters:
      authoritativeDefinitions - list of authoritative definitions

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class Object
      Returns:
      int