/*
* 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.isis.applib.services.homepage;
import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.HomePage;
import org.apache.isis.applib.annotation.Programmatic;
import org.apache.isis.applib.services.routing.RoutingService;
import org.apache.isis.applib.services.routing.RoutingServiceDefault;
/**
* Provides access to the home page object (if any).
*
* <p>
* Used by the {@link RoutingServiceDefault default implementation} of the {@link RoutingService}.
* </p>
*/
public interface HomePageProviderService {
/**
* Returns the object returned by invoking the home page action (an action of a {@link DomainService} annotated
* with {@link HomePage}.
*/
@Programmatic
Object homePage();
}