org.apache.olingo.commons.api.edm.EdmProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odata-commons-api Show documentation
The newest version!
/*
 * 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.commons.api.edm;

import org.apache.olingo.commons.api.edm.geo.SRID;

/**
 * A CSDL Property element.
 * 

 * EdmProperty defines a simple type or a complex type.
 */
public interface EdmProperty extends EdmElement, EdmMappable, EdmAnnotatable {

  /**
   * Gets the related MIME type for the property.
   *
   * @return MIME type as String
   */
  String getMimeType();

  /**
   * Gets the info if the property is a primitive property.
   *
   * @return true, if it is a primitive property
   */
  boolean isPrimitive();

  /**
   * @return true if nullable or not specified
   */
  boolean isNullable();

  /**
   * @return the maximum length as an Integer or null if not specified
   */
  Integer getMaxLength();

  /**
   * @return the precision as an Integer or null if not specified
   */
  Integer getPrecision();

  /**
   * @return the scale as an Integer or null if not specified
   */
  Integer getScale();

  /**
   * @return the scale as an String or null if not specified
   */
  String getScaleAsString();

  /**
   * @return a non-negative integer or the special value variable
   */
  SRID getSrid();

  /**
   * @return true if unicode or not specified
   */
  boolean isUnicode();

  /**
   * @return the default value as a String or null if not specified
   */
  String getDefaultValue();
  
  /**
   * See {@link EdmType} for more information about possible types.
   *
   * @return {@link EdmType}
   */
  EdmType getTypeWithAnnotations();
}