org.apache.olingo.client.api.domain.ClientComplexValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odata-v4-lib Show documentation

Repackaged OData V4 Olingo Library

There is a newer version: 3.4.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.olingo.client.api.domain;

import java.util.Map;

/**
 * OData complex property value.
 * 
 */
public interface ClientComplexValue extends ClientValue, ClientLinked, ClientAnnotatable, Iterable {

  /**
   * Adds field to the complex type.
   * 
   * @param field field to be added.
   * @return this (for fluent-style calls)
   */
  ClientComplexValue add(ClientProperty field);

  /**
   * Gets field.
   * 
   * @param name name of the field to be retrieved.
   * @return requested field.
   */
  ClientProperty get(String name);

  /**
   * Gets number of fields.
   * 
   * @return number of fields.
   */
  int size();

  /**
   * Converts this instance as POJO collection.
   * 
   * @return this instance as POJO collection
   */
  Map asJavaMap();
}