alfresco-community-repo/source/java/org/alfresco/service/cmr/thumbnail/ThumbnailService.java

/*
 * Copyright (C) 2005-2008 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program 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 General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */
package org.alfresco.service.cmr.thumbnail;

import java.util.List;

import org.alfresco.service.Auditable;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TransformationOptions;
import org.alfresco.service.namespace.QName;

/**
 * Thumbnail Service API
 * 
 * @author Roy Wetherall (based on original contribution by Ray Gauss II)
 */
public interface ThumbnailService
{
    /**
     * Creates a new thumbnail for the given node and content property.
     * 
     * The passed create options specify the details of the thumbnail, including the 
     * mimetpye, size and location of the thumbnail.
     * 
     * Once created the source node will have the 'tn:thumbnailed' aspect applied and an
     * association to the thumbnail node (or type 'tn:thumbnail') will be created.
     * 
     * The returned node reference is to the 'tn:thumbnail' content node that contains
     * the thumnail content in the standard 'cm:content' property.
     * 
     * @see org.alfresco.service.cmr.thumnail.GenerateOptions
     * 
     * @param  node                 the source content node
     * @param  contentProperty      the content property
     * @param  createOptions        the create options
     * @return NodeRef              node reference to the newly created thumbnail 
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"node", "contentProperty", "createOptions"})
    NodeRef createThumbnail(NodeRef node, QName contentProperty, CreateOptions createOptions);
    
    /**
     * Updates the content of a thumbnail.
     * 
     * The original creation options are used when updating the thumbnail.  The content of 
     * the associated thumbnailed node is used to update.
     * 
     * An error is raised if the original content no longer exisits.
     * 
     * @param thumbnail             the thumbnail node
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"thumbnail"})
    void updateThumbnail(NodeRef thumbnail);
    
    /**
     * 
     * @param node
     * @param contentProperty
     * @param thumbnailName
     * @return
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"node", "contentProperty", "thumbnailName"})
    NodeRef getThumbnailByName(NodeRef node, QName contentProperty, String thumbnailName);
    
    /**
     * 
     * @param node
     * @param contentProperty
     * @param mimetype
     * @param options
     * @return
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"node", "contentProperty", "mimetype", "options"})
    List<NodeRef> getThumbnails(NodeRef node, QName contentProperty, String mimetype, TransformationOptions options);
    
    /**
     * @see ThumbnailService#getThumbnails(NodeRef, QName, String, TransformationOptions)
     * 
     * Transformation options defaulted to null.
     * 
     * @param node
     * @param contentProperty
     * @param mimetype
     * @return
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"node", "contentProperty", "mimetype"})    
    List<NodeRef> getThumbnails(NodeRef node, QName contentProperty, String mimetype);
    
}