StyleManager.java

/**********************************************************************************
* $URL:https://source.sakaiproject.org/svn/osp/trunk/common/api/src/java/org/theospi/portfolio/style/mgt/StyleManager.java $
* $Id:StyleManager.java 9134 2006-05-08 20:28:42Z chmaurer@iupui.edu $
***********************************************************************************
*
 * Copyright (c) 2006, 2007, 2008 The Sakai Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.theospi.portfolio.style.mgt;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.sakaiproject.content.api.ContentCollection;
import org.sakaiproject.entity.api.Reference;
import org.sakaiproject.metaobj.shared.model.Agent;
import org.sakaiproject.metaobj.shared.model.Id;
import org.theospi.portfolio.shared.model.Node;
import org.theospi.portfolio.style.model.Style;

public interface StyleManager {

   public Node getNode(Id artifactId);
   public Node getNode(Reference ref);
   
   public Style storeStyle(Style style);
   public Style storeStyle(Style style, boolean checkAuthz);
   public Style mergeStyle(Style style);
   public Style mergeStyle (Style style, boolean checkAuthz);
   public Style getStyle(Id styleId);
   public boolean deleteStyle(final Id styleId);
   public Style getLightWeightStyle(final Id styleId);
   
   public Collection findSiteStyles(String currentWorksiteId);
   public Collection findPublishedStyles(String currentWorksiteId);

   public Collection findGlobalStyles(Agent agent);
   
   public boolean isGlobal();
   
   public void packageStyleForExport(Set styleIds, OutputStream os) throws IOException;
   public Map importStyleList(ContentCollection parent, String siteId, InputStream in) throws IOException;
   
   /** This function returns all styles */
   public Collection getStylesForWarehouse();
   
   public List getConsumers();

   public List getStyles(Id consumerId);
   
   /**
    * Take a list of style objects and return a list of the external urls.
    * @param styles
    * @return
    */
   public List<String> createStyleUrlList(List<Style> styles);

   /**
    * Get a Style's url
    * @param style
    * @return
    */
   public String getStyleUrl(Style style);
}