001/**
002 * Copyright 2005-2017 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.kew.doctype.bo;
017
018import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
019
020/**
021 * This is a description of what this class does - Garey don't forget to fill this in.
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 *
025 */
026public interface DocumentTypeEBO extends ExternalizableBusinessObject{
027
028        public String getDocTypeParentId();
029
030        public String getDescription();
031
032        /**
033         * This method gets the help definition url from this object and resolves any
034         * potential variables that may be in use
035         */
036        public String getHelpDefinitionUrl();
037
038        public String getLabel();
039
040        public String getName();
041
042        public String getDocumentTypeId();
043
044        /**
045         * Returns the application id for this DocumentType which can be specified on the document type itself,
046         * inherited from the parent, or defaults to the configured application id of the application.
047         *
048         * chb:12Nov2008: seems like the accessor should return the field and the auxiliary method "getActualFoo" should
049         * be the one to do more elaborate checking
050         */
051        public String getApplicationId();
052
053        /**
054         * In order to make this object Inactivateable. Not sure if I
055         * should remove the getActive method.
056         *
057         * @see org.kuali.rice.core.api.mo.common.active.MutableInactivatable#isActive()
058         */
059        public boolean isActive();
060
061}