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.krad.web.form;
017
018import org.apache.commons.lang.StringUtils;
019import org.kuali.rice.core.api.CoreApiServiceLocator;
020import org.kuali.rice.kew.api.WorkflowDocument;
021import org.kuali.rice.kim.api.identity.Person;
022import org.kuali.rice.kim.api.services.KimApiServiceLocator;
023import org.kuali.rice.krad.document.Document;
024import org.kuali.rice.krad.service.KRADServiceLocatorWeb;
025import org.kuali.rice.krad.web.bind.RequestAccessible;
026
027/**
028 * Base form for all <code>DocumentView</code> screens
029 *
030 * @author Kuali Rice Team (rice.collab@kuali.org)
031 */
032public class DocumentFormBase extends UifFormBase {
033        private static final long serialVersionUID = 2190268505427404480L;
034
035        private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DocumentFormBase.class);
036
037        private String annotation = "";
038
039    @RequestAccessible
040        private String command;
041
042    @RequestAccessible
043        private String docId;
044
045    @RequestAccessible
046        private String docTypeName;
047
048        protected Document document;
049
050    public DocumentFormBase() {
051            super();
052
053            instantiateDocument();
054        }
055
056        public String getAnnotation() {
057                return this.annotation;
058        }
059
060        public void setAnnotation(String annotation) {
061                this.annotation = annotation;
062        }
063
064        public Document getDocument() {
065                return this.document;
066        }
067
068        public void setDocument(Document document) {
069                this.document = document;
070        }
071
072    public String getDocTypeName() {
073        if (this.docTypeName == null && !this.getDefaultDocumentTypeName().isEmpty()) {
074            return this.getDefaultDocumentTypeName();
075        }
076        return this.docTypeName;
077    }
078
079        public void setDocTypeName(String docTypeName) {
080                this.docTypeName = docTypeName;
081        }
082
083        public String getCommand() {
084                return this.command;
085        }
086
087        public void setCommand(String command) {
088                this.command = command;
089        }
090
091        public String getDocId() {
092                return this.docId;
093        }
094
095        public void setDocId(String docId) {
096                this.docId = docId;
097        }
098
099    protected String getDefaultDocumentTypeName() {
100        return "";
101    }
102
103    protected void instantiateDocument() {
104        if (document == null && StringUtils.isNotBlank(getDefaultDocumentTypeName())) {
105            Class<? extends Document> documentClass = KRADServiceLocatorWeb.getDataDictionaryService()
106                    .getValidDocumentClassByTypeName(getDefaultDocumentTypeName());
107            try {
108                Document newDocument = documentClass.newInstance();
109                setDocument(newDocument);
110            } catch (Exception e) {
111                LOG.error("Unable to instantiate document class " + documentClass + " document type "
112                        + getDefaultDocumentTypeName());
113                throw new RuntimeException("Unable to instantiate document class " + documentClass + " document type "
114                        + getDefaultDocumentTypeName(),e);
115            }
116        }
117    }
118
119        /**
120         * Retrieves the principal name (network id) for the document's initiator
121         *
122         * @return String initiator name
123         */
124        public String getDocumentInitiatorNetworkId() {
125                String initiatorNetworkId = "";
126                if (getWorkflowDocument() != null) {
127                        String initiatorPrincipalId = getWorkflowDocument().getInitiatorPrincipalId();
128                        Person initiator = KimApiServiceLocator.getPersonService().getPerson(initiatorPrincipalId);
129                        if (initiator != null) {
130                                initiatorNetworkId = initiator.getPrincipalName();
131                        }
132                }
133
134                return initiatorNetworkId;
135        }
136
137        /**
138         * Retrieves the create date for the forms document and formats for
139         * presentation
140         *
141         * @return String formatted document create date
142         */
143    public String getDocumentCreateDate() {
144        String createDateStr = "";
145        if (getWorkflowDocument() != null && getWorkflowDocument().getDateCreated() != null) {
146            createDateStr = CoreApiServiceLocator.getDateTimeService().toString(
147                    getWorkflowDocument().getDateCreated().toDate(), "hh:mm a MM/dd/yyyy");
148        }
149
150        return createDateStr;
151    }
152
153        /**
154         * Retrieves the <code>WorkflowDocument</code> instance from the forms
155         * document instance
156         *
157         * @return WorkflowDocument for the forms document
158         */
159        public WorkflowDocument getWorkflowDocument() {
160                return getDocument().getDocumentHeader().getWorkflowDocument();
161        }
162
163}