org.openlca.proto.ProtoRefOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of olca-proto Show documentation
There is a newer version: 2.0.1
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: olca.proto

package org.openlca.proto;

public interface ProtoRefOrBuilder extends
    // @@protoc_insertion_point(interface_extends:protolca.ProtoRef)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The reference ID (typically an UUID) of the entity.
   * 
   *
   * string id = 1 [json_name = "@id"];
   * @return The id.
   */
  java.lang.String getId();
  /**
   *    * The reference ID (typically an UUID) of the entity.
   * 
   *
   * string id = 1 [json_name = "@id"];
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString
      getIdBytes();

  /**
   *    * The name of the entity.
   * 
   *
   * string name = 2;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the entity.
   * 
   *
   * string name = 2;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * The description of the entity.
   * 
   *
   * string description = 3;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * The description of the entity.
   * 
   *
   * string description = 3;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * A version number in MAJOR.MINOR.PATCH format where the MINOR and PATCH
   * fields are optional and the fields may have leading zeros (so 01.00.00 is
   * the same as 1.0.0 or 1).
   * 
   *
   * string version = 4;
   * @return The version.
   */
  java.lang.String getVersion();
  /**
   *    * A version number in MAJOR.MINOR.PATCH format where the MINOR and PATCH
   * fields are optional and the fields may have leading zeros (so 01.00.00 is
   * the same as 1.0.0 or 1).
   * 
   *
   * string version = 4;
   * @return The bytes for version.
   */
  com.google.protobuf.ByteString
      getVersionBytes();

  /**
   *    * The timestamp when the entity was changed the last time.
   * 
   *
   * string last_change = 5;
   * @return The lastChange.
   */
  java.lang.String getLastChange();
  /**
   *    * The timestamp when the entity was changed the last time.
   * 
   *
   * string last_change = 5;
   * @return The bytes for lastChange.
   */
  com.google.protobuf.ByteString
      getLastChangeBytes();

  /**
   *    * The type name of the respective entity.
   * 
   *
   * .protolca.ProtoType type = 6 [json_name = "@type"];
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * The type name of the respective entity.
   * 
   *
   * .protolca.ProtoType type = 6 [json_name = "@type"];
   * @return The type.
   */
  org.openlca.proto.ProtoType getType();

  /**
   *    * The full path of the category of the referenced entity from top to bottom,
   * e.g. `"Elementary flows", "Emissions to air", "unspecified"`.
   * 
   *
   * repeated string category_path = 7;
   * @return A list containing the categoryPath.
   */
  java.util.List
      getCategoryPathList();
  /**
   *    * The full path of the category of the referenced entity from top to bottom,
   * e.g. `"Elementary flows", "Emissions to air", "unspecified"`.
   * 
   *
   * repeated string category_path = 7;
   * @return The count of categoryPath.
   */
  int getCategoryPathCount();
  /**
   *    * The full path of the category of the referenced entity from top to bottom,
   * e.g. `"Elementary flows", "Emissions to air", "unspecified"`.
   * 
   *
   * repeated string category_path = 7;
   * @param index The index of the element to return.
   * @return The categoryPath at the given index.
   */
  java.lang.String getCategoryPath(int index);
  /**
   *    * The full path of the category of the referenced entity from top to bottom,
   * e.g. `"Elementary flows", "Emissions to air", "unspecified"`.
   * 
   *
   * repeated string category_path = 7;
   * @param index The index of the value to return.
   * @return The bytes of the categoryPath at the given index.
   */
  com.google.protobuf.ByteString
      getCategoryPathBytes(int index);

  /**
   *    * If the entity that is described by this reference is part of a library,
   * this field contains the identifier of that library. The identifier is
   * typically just the combination of the library name and version.
   * 
   *
   * string library = 8;
   * @return The library.
   */
  java.lang.String getLibrary();
  /**
   *    * If the entity that is described by this reference is part of a library,
   * this field contains the identifier of that library. The identifier is
   * typically just the combination of the library name and version.
   * 
   *
   * string library = 8;
   * @return The bytes for library.
   */
  com.google.protobuf.ByteString
      getLibraryBytes();

  /**
   *    * This field is only valid for references of flows or impact categories and
   * contains the name (symbol) of the reference unit of that respective flow
   * or impact category.
   * 
   *
   * string ref_unit = 9;
   * @return The refUnit.
   */
  java.lang.String getRefUnit();
  /**
   *    * This field is only valid for references of flows or impact categories and
   * contains the name (symbol) of the reference unit of that respective flow
   * or impact category.
   * 
   *
   * string ref_unit = 9;
   * @return The bytes for refUnit.
   */
  com.google.protobuf.ByteString
      getRefUnitBytes();

  /**
   *    * This field is only valid for references of processes or flows and contains
   * the location name or code of that respective process or flow.
   * 
   *
   * string location = 10;
   * @return The location.
   */
  java.lang.String getLocation();
  /**
   *    * This field is only valid for references of processes or flows and contains
   * the location name or code of that respective process or flow.
   * 
   *
   * string location = 10;
   * @return The bytes for location.
   */
  com.google.protobuf.ByteString
      getLocationBytes();

  /**
   *    * In case of a reference to a flow, this field can contain the type of flow
   * that is referenced.
   * 
   *
   * .protolca.ProtoFlowType flow_type = 11;
   * @return The enum numeric value on the wire for flowType.
   */
  int getFlowTypeValue();
  /**
   *    * In case of a reference to a flow, this field can contain the type of flow
   * that is referenced.
   * 
   *
   * .protolca.ProtoFlowType flow_type = 11;
   * @return The flowType.
   */
  org.openlca.proto.ProtoFlowType getFlowType();

  /**
   *    * In case of a reference to a process, this fiel can contain the type of
   * process that is referenced.
   * 
   *
   * .protolca.ProtoProcessType process_type = 12;
   * @return The enum numeric value on the wire for processType.
   */
  int getProcessTypeValue();
  /**
   *    * In case of a reference to a process, this fiel can contain the type of
   * process that is referenced.
   * 
   *
   * .protolca.ProtoProcessType process_type = 12;
   * @return The processType.
   */
  org.openlca.proto.ProtoProcessType getProcessType();
}