Coverage Report

Coverage Report - org.kuali.rice.kns.service.TransactionalDocumentDictionaryService

Classes in this File

 /*
  * Copyright 2005-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;
 
 import java.util.Collection;
 
 import org.kuali.rice.kns.document.TransactionalDocument;
 import org.kuali.rice.kns.rule.BusinessRule;
 
 /**
  * This interface defines methods that a TransactionalDocumentDictionary Service must provide. Defines the API for the interacting
  * with TransactionalDocument-related entries in the data dictionary.
  */
 public interface TransactionalDocumentDictionaryService {
     /**
      * Returns whether or not this document's data dictionary file has flagged it to allow document copies.
      * 
      * @param document
      * @return True if copies are allowed, false otherwise.
      */
     public Boolean getAllowsCopy(TransactionalDocument document);
 
     /**
      * Retrieves a document instance by it's class name.
      * 
      * @param documentTypeName
      * @return A document instance.
      */
     public Class getDocumentClassByName(String documentTypeName);
 
     /**
      * Retrieves the full description of the transactional document as described in its data dictionary entry.
      * 
      * @param transactionalDocumentTypeName
      * @return The transactional document's full description.
      */
     public String getDescription(String transactionalDocumentTypeName);
 
     /**
      * Retrieves the label for the transactional document as described in its data dictionary entry.
      * 
      * @param transactionalDocumentTypeName
      * @return The transactional document's label.
      */
     public String getLabel(String transactionalDocumentTypeName);
 
 
     /**
      * @param document
      * @return businessRulesClass associated with the given document's type
      */
     public Class<? extends BusinessRule> getBusinessRulesClass(TransactionalDocument document);
     /**
      * The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
      * 
      * @param document
      * @return A Collection of ReferenceDefinitions
      */
     public Collection getDefaultExistenceChecks(TransactionalDocument document);
 
     /**
      * The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
      * 
      * @param docTypeName
      * @return A Collection of ReferenceDefinitions
      */
     public Collection getDefaultExistenceChecks(String docTypeName);
 }

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.service;
17
18		import java.util.Collection;
19
20		import org.kuali.rice.kns.document.TransactionalDocument;
21		import org.kuali.rice.kns.rule.BusinessRule;
22
23		/**
24		* This interface defines methods that a TransactionalDocumentDictionary Service must provide. Defines the API for the interacting
25		* with TransactionalDocument-related entries in the data dictionary.
26		*/
27		public interface TransactionalDocumentDictionaryService {
28		/**
29		* Returns whether or not this document's data dictionary file has flagged it to allow document copies.
30		*
31		* @param document
32		* @return True if copies are allowed, false otherwise.
33		*/
34		public Boolean getAllowsCopy(TransactionalDocument document);
35
36		/**
37		* Retrieves a document instance by it's class name.
38		*
39		* @param documentTypeName
40		* @return A document instance.
41		*/
42		public Class getDocumentClassByName(String documentTypeName);
43
44		/**
45		* Retrieves the full description of the transactional document as described in its data dictionary entry.
46		*
47		* @param transactionalDocumentTypeName
48		* @return The transactional document's full description.
49		*/
50		public String getDescription(String transactionalDocumentTypeName);
51
52		/**
53		* Retrieves the label for the transactional document as described in its data dictionary entry.
54		*
55		* @param transactionalDocumentTypeName
56		* @return The transactional document's label.
57		*/
58		public String getLabel(String transactionalDocumentTypeName);
59
60
61		/**
62		* @param document
63		* @return businessRulesClass associated with the given document's type
64		*/
65		public Class<? extends BusinessRule> getBusinessRulesClass(TransactionalDocument document);
66		/**
67		* The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
68		*
69		* @param document
70		* @return A Collection of ReferenceDefinitions
71		*/
72		public Collection getDefaultExistenceChecks(TransactionalDocument document);
73
74		/**
75		* The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
76		*
77		* @param docTypeName
78		* @return A Collection of ReferenceDefinitions
79		*/
80		public Collection getDefaultExistenceChecks(String docTypeName);
81		}