001/*
002 *  Copyright 2012 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.web.repository;
017
018import org.ametys.plugins.repository.AmetysObject;
019import org.ametys.plugins.repository.AmetysRepositoryException;
020import org.ametys.web.repository.site.Site;
021
022/**
023 * An ametys object that is aware of its {@link Site}.
024 */
025public interface SiteAwareAmetysObject extends AmetysObject
026{
027    /** Constants for site metadata. */
028    public static final String METADATA_SITE = "site";
029    
030    /**
031     * Returns this object's site name.
032     * @return this object's site name.
033     * @throws AmetysRepositoryException if an error occurs.
034     */
035    public String getSiteName() throws AmetysRepositoryException;
036    
037    /**
038     * Returns this object's site.
039     * @return this object's site
040     * @throws AmetysRepositoryException if an error occurs.
041     */
042    public Site getSite() throws AmetysRepositoryException;
043    
044}