001/**
002 * Copyright 2005-2017 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.notes.service;
017
018import java.io.File;
019import java.util.List;
020
021import org.kuali.rice.kew.notes.Attachment;
022import org.kuali.rice.kew.notes.Note;
023import org.springframework.core.io.Resource;
024
025/**
026 * A service which handles data access for notes and attachments.
027 * 
028 * @see Note
029 * @see Attachment
030 *
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 */
033public interface NoteService {
034
035    public Note getNoteByNoteId(String noteId);
036    
037    public List<Note> getNotesByDocumentId(String documentId);
038    
039    public Note saveNote(Note note);
040    
041    public void deleteNote(Note note);
042    
043    public void deleteAttachment(Attachment attachment);
044    
045    /**
046     * @deprecated Please use findAttachmentResource instead
047     */
048    @Deprecated
049    public File findAttachmentFile(Attachment attachment);
050    
051    public Resource findAttachmentResource(Attachment attachment);
052    
053    public Attachment findAttachment(String attachmentId);
054    
055}