org.tentackle.i18n.pdo.StoredBundleKeyPersistence Maven / Gradle / Ivy

Go to download
/*
 * Tentackle - https://tentackle.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


package org.tentackle.i18n.pdo;

import org.tentackle.bind.Bindable;
import org.tentackle.misc.TrackedList;
import org.tentackle.pdo.PersistentObject;
import org.tentackle.session.Persistent;
import org.tentackle.validate.validator.NotNull;

/**
 * Persistence interface for stored bundle keys.
 *
 * @author harald
 */
public interface StoredBundleKeyPersistence extends PersistentObject {

  // @wurblet fieldlengths ColumnLengths

////GEN-BEGIN:fieldlengths


////GEN-END:fieldlengths

  // @wurblet membernames AttributeNames

  ////GEN-BEGIN:membernames


  /** relation name for 'StoredBundle bundle via bundleId (Bundle)'. */
  String RN_BUNDLE = "bundle";

  /** attribute name for database column 'bundle_id'. */
  String AN_BUNDLEID = "bundleId";

  /** attribute name for database column 'bkey'. */
  String AN_KEY = "key";

  /** attribute name for database column 'bvalue'. */
  String AN_VALUE = "value";

  ////GEN-END:membernames

  // @wurblet methods Methods

  ////GEN-BEGIN:methods


  /**
   * Gets the attribute bundleId.
   *
   * @return the bundle id
   */
  @Persistent(ordinal=0, comment="the bundle id")
  long getBundleId();

  /**
   * Gets the attribute key.
   *
   * @return the resource bundle key
   */
  @Persistent(ordinal=1, comment="the resource bundle key")
  @NotNull
  String getKey();

  /**
   * Sets the attribute key.
   *
   * @param key the resource bundle key
   */
  void setKey(String key);

  /**
   * Gets the attribute value.
   *
   * @return the localized string
   */
  @Persistent(ordinal=2, comment="the localized string")
  @NotNull
  String getValue();

  /**
   * Sets the attribute value.
   *
   * @param value the localized string
   */
  void setValue(String value);

  ////GEN-END:methods

  // @wurblet relations Relations

  ////GEN-BEGIN:relations


  /**
   * Gets StoredBundle bundle via bundleId (Bundle).
   *
   * @return bundle Bundle
   */
  @Bindable
  @Persistent(ordinal=0, comment="Bundle", component=false, parent=true)
  StoredBundle getBundle();

  /**
   * Sets StoredBundle bundle via bundleId (Bundle).
   *
   * @param bundle Bundle
   */
  void setBundle(StoredBundle bundle);

  /**
   * Selects composite list of StoredBundleKey keys via StoredBundleKey#bundleId (Keys).
   *
   * @param bundleId the bundle id
   * @return Keys
   */
  TrackedList selectByBundleId(long bundleId);

  ////GEN-END:relations

}