org.apache.olingo.commons.api.edm.EdmOperation 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.commons.api.edm;
import java.util.List;
/**
* A EdmOperation can either be an {@link EdmAction} or an {@link EdmFunction}.
*/
public interface EdmOperation extends EdmType, EdmAnnotatable {
/**
* Get parameter for given name
* @param name name of parameter
* @return {@link EdmParameter} for this name
*/
EdmParameter getParameter(String name);
/**
* A list of all parameter names. If this is a bound action or function the first parameter name in the list is the
* binding parameter
* @return a list of all parameter names
*/
List getParameterNames();
/**
* Get EdmEntitySet for the given binding parameters EntitySet
*
* @param bindingParameterEntitySet EntitySet of binding parameter
* @return {@link EdmEntitySet} for this binding
*/
EdmEntitySet getReturnedEntitySet(EdmEntitySet bindingParameterEntitySet);
/**
* @return {@link EdmReturnType} of this operation
*/
EdmReturnType getReturnType();
/**
* For more information on bound operations please refer to the OData V4 specification.
*
* @return true if bound
*/
boolean isBound();
/**
* @return the fullqualified type name of the binding parameter
*/
FullQualifiedName getBindingParameterTypeFqn();
/**
* @return true if binding parameter is of type collection.
*/
Boolean isBindingParameterTypeCollection();
/**
* @return the entity set path as a String or null if not present
*/
String getEntitySetPath();
}