View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  package javax.jdo.metadata;
    18
    19  /**
    20   * Represents a fetch group for a class.
    21   * @since 3.0
    22   */
    23  public interface FetchGroupMetadata extends Metadata {
    24      /**
    25       * Accessor for the fetch group name (set on construction).
    26       *
    27       * @return The fetch group name
    28       */
    29      String getName();
    30
    31      /**
    32       * Method to set whether to call post load with this fetch group
    33       *
    34       * @param load Call post load
    35       */
    36      FetchGroupMetadata setPostLoad(boolean load);
    37
    38      /**
    39       * Accessor for whether to call post load for this fetch group
    40       *
    41       * @return Whether to call post-load
    42       */
    43      Boolean getPostLoad();
    44
    45      /**
    46       * Accessor for all fields/properties defined on the fetch group.
    47       * @return The members
    48       */
    49      MemberMetadata[] getMembers();
    50
    51      /**
    52       * Accessor for the number of fields/properties defined for this fetch group.
    53       *
    54       * @return The number of members
    55       */
    56      int getNumberOfMembers();
    57
    58      /**
    59       * Add a new field for this fetch group.
    60       *
    61       * @param name Name of field
    62       * @return The FieldMetadata
    63       */
    64      FieldMetadata newFieldMetadata(String name);
    65
    66      /**
    67       * Add a new property for this fetch group
    68       *
    69       * @param name Name of property
    70       * @return The PropertyMetadata
    71       */
    72      PropertyMetadata newPropertyMetadata(String name);
    73  }