001/**
002 * Copyright 2005-2015 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 Only used in KNS classes, use KRAD.
028 */
029@Deprecated
030public interface TransactionalDocumentDictionaryService {
031    /**
032     * Returns whether or not this document's data dictionary file has flagged it to allow document copies.
033     * 
034     * @param document
035     * @return True if copies are allowed, false otherwise.
036     */
037    public Boolean getAllowsCopy(TransactionalDocument document);
038
039    /**
040     * Retrieves a document instance by it's class name.
041     * 
042     * @param documentTypeName
043     * @return A document instance.
044     */
045    public Class getDocumentClassByName(String documentTypeName);
046
047    /**
048     * Retrieves the full description of the transactional document as described in its data dictionary entry.
049     * 
050     * @param transactionalDocumentTypeName
051     * @return The transactional document's full description.
052     */
053    public String getDescription(String transactionalDocumentTypeName);
054
055    /**
056     * Retrieves the label for the transactional document as described in its data dictionary entry.
057     * 
058     * @param transactionalDocumentTypeName
059     * @return The transactional document's label.
060     */
061    public String getLabel(String transactionalDocumentTypeName);
062
063
064    /**
065     * The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
066     * 
067     * @param document
068     * @return A Collection of ReferenceDefinitions
069     */
070    public Collection getDefaultExistenceChecks(TransactionalDocument document);
071
072    /**
073     * The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
074     * 
075     * @param docTypeName
076     * @return A Collection of ReferenceDefinitions
077     */
078    public Collection getDefaultExistenceChecks(String docTypeName);
079}