org.openmdx.kernel.cci2.Query Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmdx-client Show documentation
openMDX/Client Library
There is a newer version: 2.18.10
// ----------------------------------------------------------------------------
// StructureType/Begin
// ----------------------------------------------------------------------------
//////////////////////////////////////////////////////////////////////////////
//
// Generated by org.openmdx.application.mof.mapping.java.StructureMapper 2.17.7
// Generated at 2020-11-27T16:04:08.417Z
//
// GENERATED - DO NOT CHANGE MANUALLY
//
//////////////////////////////////////////////////////////////////////////////
package org.openmdx.kernel.cci2;

public interface Query
{
// ----------------------------------------------------------------------------
// StructureType/FieldGetSet
// ----------------------------------------------------------------------------
  /**
   * Retrieves a set containing all the elements for the structure field featureName.
   * @return A set containing all elements for this structure field.
   */
  public java.util.Set getFeatureName(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the optional structure field fetchGroupName.
   * @return The possibly null value for structure field fetchGroupName.
   */
  public java.lang.String getFetchGroupName(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the optional structure field position.
   * @return The possibly null value for structure field position.
   */
  public java.lang.Long getPosition(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the optional structure field query.
   * @return The possibly null value for structure field query.
   */
  public java.lang.String getQuery(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the optional structure field queryFilter.
   * @return The possibly null value for structure field queryFilter.
   */
  public org.openmdx.kernel.cci2.QueryFilter getQueryFilter(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the optional structure field queryType.
   * @return The possibly null value for structure field queryType.
   */
  public java.lang.String getQueryType(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet1_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the structure field refresh.
   * @return The non-null value for structure field refresh.
   */
  public boolean isRefresh(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the optional structure field resourceIdentifier.
   * @return The possibly null value for structure field resourceIdentifier.
   */
  public org.openmdx.base.naming.Path getResourceIdentifier(
  );

// ----------------------------------------------------------------------------
// StructureType/FieldGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the optional structure field size.
   * @return The possibly null value for structure field size.
   */
  public java.lang.Long getSize(
  );


// ----------------------------------------------------------------------------
// StructureType/Member
// ----------------------------------------------------------------------------

  /**
   * The structure's members
   */
  enum Member {
    featureName
  , fetchGroupName
  , position
  , query
  , queryFilter
  , queryType
  , refresh
  , resourceIdentifier
  , size
  }

// ----------------------------------------------------------------------------
// StructureType/End
// ----------------------------------------------------------------------------
}