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