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