| /* |
| * 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.queryoption; |
| |
| import org.apache.olingo.commons.api.edm.EdmType; |
| import org.apache.olingo.server.api.uri.UriInfoResource; |
| |
| /** |
| * Represents a single resource path which should be expanded with using the system query option $expand |
| * For example: http://.../entitySet?$expand=Products($filter=DiscontinuedDate eq null) |
| */ |
| public interface ExpandItem { |
| |
| /** |
| * @return Information of the option $level when used within $expand |
| */ |
| LevelsExpandOption getLevelsOption(); |
| |
| /** |
| * @return Information of the option $filter when used within $expand |
| */ |
| FilterOption getFilterOption(); |
| |
| /** |
| * @return Information of the option $search when used within $expand |
| */ |
| SearchOption getSearchOption(); |
| |
| /** |
| * @return Information of the option $orderby when used within $expand |
| */ |
| OrderByOption getOrderByOption(); |
| |
| /** |
| * @return Information of the option $skip when used within $expand |
| */ |
| SkipOption getSkipOption(); |
| |
| /** |
| * @return Information of the option $top when used within $expand |
| */ |
| TopOption getTopOption(); |
| |
| /** |
| * @return Information of the option $count when used within $expand |
| */ |
| CountOption getCountOption(); |
| |
| /** |
| * @return Information of the option $select when used within $expand |
| */ |
| SelectOption getSelectOption(); |
| |
| /** |
| * @return Information of the option $expand when used within $expand |
| */ |
| ExpandOption getExpandOption(); |
| |
| /** |
| * @return A {@link UriInfoResource} object containing the resource path segments to be expanded |
| */ |
| UriInfoResource getResourcePath(); |
| |
| /** |
| * @return A star is used within $expand. |
| * For example: ...?$expand=* |
| */ |
| boolean isStar(); |
| |
| /** |
| * @return A $ref is used within $expand. |
| * For example: ...?$expand=$ref |
| */ |
| boolean isRef(); |
| |
| /** |
| * @return Before resource path segments which should be expanded a type filter may be used. |
| * For example: ...persons?$expand=namespace.managertype/team |
| */ |
| EdmType getStartTypeFilter(); |
| |
| } |