odata2-lib/odata-client-api/src/main/java/org/apache/olingo/odata2/client/api/edm/EdmDocumentation.java

/*******************************************************************************
 * 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.odata2.client.api.edm;

import java.util.List;

import org.apache.olingo.odata2.api.edm.EdmAnnotationAttribute;
import org.apache.olingo.odata2.api.edm.EdmAnnotationElement;

/**
 * Objects of this class represent documentation
 * 
 */
public interface EdmDocumentation {

  /**
   * Sets the summary for this {@link EdmDocumentation}
   * @param summary
   * @return {@link EdmDocumentation} for method chaining
   */
  public EdmDocumentation setSummary(final String summary);

  /**
   * Sets the long description for this {@link EdmDocumentation}
   * @param longDescription
   * @return {@link EdmDocumentation} for method chaining
   */
  public EdmDocumentation setLongDescription(final String longDescription) ;
  /**
   * Sets the collection of {@link AnnotationAttribute} for this {@link EdmDocumentation}
   * @param annotationAttributes
   * @return {@link EdmDocumentation} for method chaining
   */
  public EdmDocumentation setAnnotationAttributes(final List<EdmAnnotationAttribute> annotationAttributes) ;

  /**
   * Sets the collection of {@link AnnotationElement} for this {@link EdmDocumentation}
   * @param annotationElements
   * @return {@link EdmDocumentation} for method chaining
   */
  public EdmDocumentation setAnnotationElements(final List<EdmAnnotationElement> annotationElements);
}