001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kns.service;
017
018import org.kuali.rice.krad.document.TransactionalDocument;
019import org.kuali.rice.krad.rules.rule.BusinessRule;
020
021import java.util.Collection;
022
023/**
024 * This interface defines methods that a TransactionalDocumentDictionary Service must provide. Defines the API for the interacting
025 * with TransactionalDocument-related entries in the data dictionary.
026 */
027@Deprecated
028public interface TransactionalDocumentDictionaryService {
029    /**
030     * Returns whether or not this document's data dictionary file has flagged it to allow document copies.
031     * 
032     * @param document
033     * @return True if copies are allowed, false otherwise.
034     */
035    public Boolean getAllowsCopy(TransactionalDocument document);
036
037    /**
038     * Retrieves a document instance by it's class name.
039     * 
040     * @param documentTypeName
041     * @return A document instance.
042     */
043    public Class getDocumentClassByName(String documentTypeName);
044
045    /**
046     * Retrieves the full description of the transactional document as described in its data dictionary entry.
047     * 
048     * @param transactionalDocumentTypeName
049     * @return The transactional document's full description.
050     */
051    public String getDescription(String transactionalDocumentTypeName);
052
053    /**
054     * Retrieves the label for the transactional document as described in its data dictionary entry.
055     * 
056     * @param transactionalDocumentTypeName
057     * @return The transactional document's label.
058     */
059    public String getLabel(String transactionalDocumentTypeName);
060
061
062    /**
063     * The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
064     * 
065     * @param document
066     * @return A Collection of ReferenceDefinitions
067     */
068    public Collection getDefaultExistenceChecks(TransactionalDocument document);
069
070    /**
071     * The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
072     * 
073     * @param docTypeName
074     * @return A Collection of ReferenceDefinitions
075     */
076    public Collection getDefaultExistenceChecks(String docTypeName);
077}