/* ======================================================================
   Parts Copyright 2006 University of Leeds, Oxford University, University of the Highlands and Islands.

   Licensed 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.bodington.server;

import java.security.acl.NotOwnerException;

import org.bodington.server.resources.EasyEditResource;
import org.bodington.server.resources.Resource;

public interface HomeSession extends BuildingSession
{
    /**
     * Bookmark a resource for this user.
     * @param resource The resource to bookmark.
     */
    public void createBookmark(Resource resource) throws BuildingServerException;

    /**
     * Get the container for a users bookmarks.
     * @return The bookmarks resource.
     */
    public Resource getBookmarkContainer() throws BuildingServerException;
    
    public boolean isPublic() throws BuildingServerException;
    
    public void makePublic() throws BuildingServerException, NotOwnerException;
    
    public boolean isVisible() throws BuildingServerException;
    
    public void makeVisible() throws BuildingServerException, NotOwnerException;

    /**
     * Create an instance of "notes" for this user. This is a resource called
     * <code>notes</code> which is an instance of {@link EasyEditResource} and
     * is placed in the root of their home area.
     */
    public void createNotes() throws BuildingServerException;
}