/*******************************************************************************
* 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.jpa.processor.api.model;
import java.util.List;
import org.apache.olingo.odata2.api.edm.provider.EntityContainer;
/**
* A view on JPA EDM entity container. JPA EDM entity container is built from
* consistent JPA EDM entity set and consistent JPA EDM association set views.
*
* <p>
* The implementation of the view provides access to EDM entity containers. The
* view acts as container for JPA EDM entity containers. A JPA EDM entity
* container is said to be consistent only if the JPA EDM association set and
* JPA EDM Entity Set view are consistent.
*
*
* @org.apache.olingo.odata2.DoNotImplement
* @see org.apache.olingo.odata2.jpa.processor.api.model.JPAEdmEntitySetView
* @see org.apache.olingo.odata2.jpa.processor.api.model.JPAEdmAssociationSetView
*
*/
public interface JPAEdmEntityContainerView extends JPAEdmBaseView {
/**
* The method returns the EDM entity container that is currently being
* processed.
*
* @return an instance of type {@link org.apache.olingo.odata2.api.edm.provider.EntityContainer}
*/
public EntityContainer getEdmEntityContainer();
/**
* The method returns a list of consistent EDM entity containers
*
* @return a list of consistent EDM entity containers
*/
public List<EntityContainer> getConsistentEdmEntityContainerList();
/**
* The method returns the JPA EDM entity set view that is currently being
* processed.
*
* @return an instance of type {@link org.apache.olingo.odata2.jpa.processor.api.model.JPAEdmEntitySetView}
*/
public JPAEdmEntitySetView getJPAEdmEntitySetView();
/**
* The method returns the JPA EDM association set view that is currently
* being processed.
*
* @return an instance of type {@link org.apache.olingo.odata2.jpa.processor.api.model.JPAEdmAssociationSetView}
*/
public JPAEdmAssociationSetView getEdmAssociationSetView();
}