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