/*******************************************************************************
* Copyright 2013 SAP AG
*
* Licensed 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 com.sap.core.odata.processor.api.jpa.jpql;
/**
* The interface provides a view on JPQL Context. The view can be used to access
* different JPQL context type implementations.
*
* @author SAP AG
* @see com.sap.core.odata.processor.api.jpa.jpql.JPQLContextType
* @see com.sap.core.odata.processor.api.jpa.jpql.JPQLContextType
*/
public interface JPQLContextView {
/**
* The method returns a JPA entity name for which the JPQL context is
* relevant.
*
* @return JPA entity name
*/
public String getJPAEntityName();
/**
* The method returns a JPA entity alias name for which the JPQL context is
* relevant.
*
* @return JPA entity alias name
*/
public String getJPAEntityAlias();
/**
* The method returns a JPQL context type
*
* @return an instance of type
* {@link com.sap.core.odata.processor.api.jpa.jpql.JPQLContextType}
*/
public JPQLContextType getType();
}