/*

  * Copyright 2007 The Kuali 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/ecl2.php

  * 

  * 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.kuali.rice.kns.service.impl;

 import java.util.List;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.kns.bo.Note;

 import org.kuali.rice.kns.bo.PersistableBusinessObject;

 import org.kuali.rice.kns.dao.NoteDao;

 import org.kuali.rice.kns.service.AttachmentService;

 import org.kuali.rice.kns.service.NoteService;

 import org.kuali.rice.kns.util.ObjectUtils;

 import org.springframework.transaction.annotation.Transactional;

 /**

  * This class is the service implementation for the Note structure.

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 @Transactional

 public class NoteServiceImpl implements NoteService {

     private NoteDao noteDao;

     private AttachmentService attachmentService;

     public NoteServiceImpl() {

         super();

     }

     /**

      * @see org.kuali.rice.kns.service.NoteService#saveNoteValueList(java.util.List)

      */

     public void saveNoteList(List<Note> notes) {

         if (notes != null) {

             for (Note note : notes) {

                     if (StringUtils.isBlank(note.getRemoteObjectIdentifier())) {

                             throw new IllegalStateException("The remote object identifier must be established on a Note before it can be saved.  The following note in the given list had a null or empty remote object identifier: " + note);

                     }

                 save(note);

             }

         }

     }

     /**

      * @see org.kuali.rice.kns.service.NoteService#save(org.kuali.rice.kns.bo.Note)

      */

     public Note save(Note note) {

             validateNoteNotNull(note);

             if (StringUtils.isBlank(note.getRemoteObjectIdentifier())) {

                     throw new IllegalStateException("The remote object identifier must be established on a Note before it can be saved.  Given note had a null or empty remote object identifier.");

             }

         noteDao.save(note);

         // move attachment from pending directory

         if (note.getAttachment() != null) {

                 attachmentService.moveAttachmentWherePending(note);

         }

         return note;

     }

     /**

      * @see org.kuali.rice.kns.service.NoteService#getByRemoteObjectId(java.lang.String)

      */

     public List<Note> getByRemoteObjectId(String remoteObjectId) {

             if (StringUtils.isBlank(remoteObjectId)) {

                     throw new IllegalArgumentException("The remoteObjectId must not be null or blank.");

             }

         return noteDao.findByremoteObjectId(remoteObjectId);

     }

     /**

      * @see org.kuali.rice.kns.service.NoteService#getNoteByNoteId(java.lang.Long)

      */

     public Note getNoteByNoteId(Long noteId) {

             if (noteId == null) {

                     throw new IllegalArgumentException("The noteId must not be null.");

             }

                 return noteDao.getNoteByNoteId(noteId);

         }

     /**

      * @see org.kuali.rice.kns.service.NoteService#deleteNote(org.kuali.rice.kns.bo.Note)

      */

     public void deleteNote(Note note) {

             validateNoteNotNull(note);

         noteDao.deleteNote(note);

     }

     /**

      * TODO this method seems awfully out of place in this service

      * 

      * @see org.kuali.rice.kns.service.NoteService#createNote(org.kuali.rice.kns.bo.Note, org.kuali.rice.kns.bo.PersistableBusinessObject)

      */

     public Note createNote(Note noteToCopy, PersistableBusinessObject bo, String authorPrincipalId) {

             validateNoteNotNull(noteToCopy);

             if (bo == null) {

                     throw new IllegalArgumentException("The bo must not be null.");

             }

             if (StringUtils.isBlank(authorPrincipalId)) {

                     throw new IllegalArgumentException("The authorPrincipalId must not be null.");

             }

         // TODO: Why is a deep copy being done?  Nowhere that this is called uses the given note argument

         // again after calling this method.

         Note tmpNote = (Note) ObjectUtils.deepCopy(noteToCopy);

         tmpNote.setRemoteObjectIdentifier(bo.getObjectId());

         tmpNote.setAuthorUniversalIdentifier(authorPrincipalId);

         return tmpNote;

     }

     /**

      * Sets the data access object

      * 

      * @param d

      */

     public void setNoteDao(NoteDao d) {

         this.noteDao = d;

     }

     /**

      * Retrieves a data access object

      */

     protected NoteDao getNoteDao() {

         return noteDao;

     }

     public void setAttachmentService(AttachmentService attachmentService) {

             this.attachmentService = attachmentService;

     }

     protected AttachmentService getAttachmentService() {

             return this.attachmentService;

     }

     private void validateNoteNotNull(Note note) {

             if (note == null) {

                     throw new IllegalArgumentException("Note must not be null.");

             }

     }

 }