View Javadoc

1   /*
2    * Copyright 2005-2007 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    * http://www.opensource.org/licenses/ecl2.php
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.kns.document;
17  
18  import javax.persistence.MappedSuperclass;
19  
20  import org.kuali.rice.kns.service.KNSServiceLocator;
21  
22  /**
23   * This is the base class implementation for all transaction processing eDocs. 
24   */
25  @MappedSuperclass
26  public abstract class TransactionalDocumentBase extends DocumentBase implements TransactionalDocument,  SessionDocument {
27      private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(TransactionalDocumentBase.class);
28  
29      /**
30       * Default constructor.
31       */
32      public TransactionalDocumentBase() {
33          super();
34      }
35  
36      /**
37       * @see org.kuali.rice.kns.document.TransactionalDocument#getAllowsCopy()
38       * Checks if copy is set to true in data dictionary and the document instance implements
39       * Copyable.
40       */
41      public boolean getAllowsCopy() {
42          return KNSServiceLocator.getTransactionalDocumentDictionaryService().getAllowsCopy(this).booleanValue() && this instanceof Copyable;
43      }
44  
45      /**
46       * 
47       * This method to check whether the document class implements SessionDocument
48       * 
49       * @return
50       */
51      public boolean isSessionDocument() {
52          return SessionDocument.class.isAssignableFrom(this.getClass());
53      }
54  
55      
56  }