org.apache.olingo.server.api.uri.UriResourceFunction Maven / Gradle / Ivy
/*
* 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.server.api.uri;
import java.util.List;
import org.apache.olingo.commons.api.edm.EdmFunction;
import org.apache.olingo.commons.api.edm.EdmFunctionImport;
import org.apache.olingo.commons.api.edm.EdmType;
/**
* Used to describe an function import or bound function used within an resource path
* For example: http://.../serviceroot/functionImport(P1=1,P2='A')
*/
public interface UriResourceFunction extends UriResourcePartTyped {
/**
* If the resource path specifies a function import this method will deliver the unbound function for the function
* import.
* @return Function used in the resource path or function import
*/
EdmFunction getFunction();
/**
* Convenience method which returns the {@link EdmFunctionImport} which was used in
* the resource path to define the {@link EdmFunction}.
* @return Function Import used in the resource path
*/
EdmFunctionImport getFunctionImport();
/**
* @return Key predicates if used, otherwise an empty list
*/
List getKeyPredicates();
/**
* @return List of function parameters
*/
List getParameters();
/**
* @return Type filter before key predicates if used, otherwise null
*/
EdmType getTypeFilterOnCollection();
/**
* @return Type filter behind key predicates if used, otherwise null
*/
EdmType getTypeFilterOnEntry();
}