View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.core.document.dao;
17  
18  import java.util.List;
19  
20  import org.kuali.student.common.dao.CrudDao;
21  import org.kuali.student.common.dao.SearchableDao;
22  import org.kuali.student.common.exceptions.DoesNotExistException;
23  import org.kuali.student.core.document.entity.Document;
24  import org.kuali.student.core.document.entity.DocumentCategory;
25  import org.kuali.student.core.document.entity.RefDocRelation;
26  
27  /**
28   * This is a description of what this class does - lindholm don't forget to fill this in.
29   *
30   * @author Kuali Rice Team (kuali-rice@googlegroups.com)
31   *
32   */
33  public interface DocumentDao extends CrudDao, SearchableDao {
34  
35      public Boolean addDocumentCategoryToDocument(String documentId, String documentCategoryKey) throws DoesNotExistException;
36  
37      public List<DocumentCategory> getCategoriesByDocument(String documentId);
38  
39      public List<Document> getDocumentsByIdList(List<String> documentIdList) throws DoesNotExistException;
40  
41      public Boolean removeDocumentCategoryFromDocument(String documentId, String documentCategoryKey) throws DoesNotExistException;
42  
43  	public List<RefDocRelation> getRefDocRelationsByRef(String refObjectTypeKey,
44  			String refObjectId);
45  
46  	public List<RefDocRelation> getRefDocRelationsByDoc(String documentId);
47  
48  }