001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.servlet;
014
015import org.apache.juneau.rest.*;
016import org.apache.juneau.rest.annotation.*;
017import org.apache.juneau.rest.beans.*;
018
019/**
020 * Basic REST group operation methods.
021 *
022 * <p>
023 *    Defines 1 special use REST operation endpoint:
024 * </p>
025 *
026 * <p class='bjava'>
027 *    <ja>@RestGet</ja>(path=<js>"/*"</js></js>)
028 *    <jk>public</jk> {@link ChildResourceDescriptions} {@link #getChildren(RestRequest) getChildren}({@link RestRequest} <jv>req</jv>);
029 * </p>
030 *
031 * <p>
032 *    Implementations provided by the following classes:
033 * </p>
034 * <ul class='javatreec'>
035 *    <li class='jac'>{@link BasicRestServletGroup}
036 *    <li class='jac'>{@link BasicRestObjectGroup}
037 * </ul>
038 *
039 * <h5 class='section'>See Also:</h5><ul>
040 *    <li class='link'><a class="doclink" href="../../../../../index.html#jrs.AnnotatedClasses">@Rest-Annotated Classes</a>
041 * </ul>
042 */
043public interface BasicGroupOperations {
044
045   /**
046    * [GET /] - Get child resources.
047    *
048    * <p>
049    * Returns a bean that lists and allows navigation to child resources.
050    *
051    * @param req The HTTP request.
052    * @return The bean containing links to the child resources.
053    */
054   @RestGet(path="/", summary="Navigation page")
055   public ChildResourceDescriptions getChildren(RestRequest req);
056}