org.gatein.api.page.Page Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gatein-api
There is a newer version: 1.1.0.Final
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.gatein.api.page;

import java.io.Serializable;

import org.gatein.api.Portal;
import org.gatein.api.common.Describable;
import org.gatein.api.common.Displayable;
import org.gatein.api.security.Permission;
import org.gatein.api.site.SiteId;

/**
 * Represents a portal page. Any chances to a page is not perisisted until {@link Portal#savePage(Page)} is invoked.
 * 
 * @author Nick Scavelli
 */
public interface Page extends Displayable, Describable, Comparable, Serializable {
    /**
     * The id of the page
     * 
     * @return the id
     */
    PageId getId();

    /**
     * The id of the site the page belongs to
     * 
     * @return the site id
     */
    SiteId getSiteId();

    /**
     * The name of the page
     * 
     * @return the name
     */
    String getName();

    /**
     * The permissions that represents what users are allowed to access the page
     * 
     * @return the access permission
     */
    Permission getAccessPermission();

    /**
     * Sets the access permission
     * 
     * @param permission the access permission
     */
    void setAccessPermission(Permission permission);

    /**
     * The permissions that represents what users are allowed to modify the page
     * 
     * @return the edit permission
     */
    Permission getEditPermission();

    /**
     * Sets the edit permission
     * 
     * @param permission the edit permission
     */
    void setEditPermission(Permission permission);
}