/*
 * Copyright (c) 2007 BUSINESS OBJECTS SOFTWARE LIMITED
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 * 
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 * 
 *     * Neither the name of Business Objects nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/*
 * WorkspaceDeclarationManager.java
 * Creation date: Dec 10, 2004.
 * By: Edward Lam
 */
package org.openquark.cal.services;

import java.io.OutputStream;


/**
 * A manager to manage saving and loading workspace declarations using a workspace declaration store.
 * @author Edward Lam
 */
public class WorkspaceDeclarationManager extends ResourceManager {
    
    /** The store used by this manager to manage workspace declarations. */
    private final WorkspaceDeclarationStore workspaceDeclarationStore;

    /**
     * Constructor for a WorkspaceDeclarationManager.
     * @param workspaceDeclarationStore the store which contains the workspace declarations managed by this manager.
     */
    public WorkspaceDeclarationManager(WorkspaceDeclarationStore workspaceDeclarationStore) {
        this.workspaceDeclarationStore = workspaceDeclarationStore;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getResourceType() {
        return WorkspaceResource.WORKSPACE_DECLARATION_RESOURCE_TYPE;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ResourceStore getResourceStore() {
        return workspaceDeclarationStore;
    }

    /**
     * Save a declaration to this manager.
     * @param workspaceDeclaration the workspace declaration to save.
     * @param putStatus the tracking status object.
     * @return whether the declaration was successfully saved.
     */
    public boolean saveDeclaration(String workspaceDeclarationName, WorkspaceDeclaration workspaceDeclaration, Status putStatus) {
        WorkspaceDeclarationFeatureName featureName = WorkspaceDeclarationFeatureName.getWorkspaceDeclarationFeatureName(workspaceDeclarationName);
        ResourceName resourceName = new ResourceName(featureName);
        
        // Create an output stream for the declaration.
        OutputStream declarationOutputStream = workspaceDeclarationStore.getOutputStream(resourceName, putStatus);
        if (declarationOutputStream == null) {
            return false;
        }

        // Save the declaration to the output stream.
        workspaceDeclaration.saveDeclaration(workspaceDeclarationName, declarationOutputStream, putStatus);
        
        return true;
    }
    
}