Coverage Report

Coverage Report - org.kuali.rice.kns.web.spring.form.DocumentFormBase

Classes in this File

Line Coverage

Branch Coverage

Complexity

DocumentFormBase

0/42

0/12

1.5

 /*
  * Copyright 2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 1.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl1.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.kuali.rice.kns.web.spring.form;
 
 import org.apache.commons.lang.StringUtils;
 import org.kuali.rice.core.api.services.CoreApiServiceLocator;
 import org.kuali.rice.kim.api.services.KimApiServiceLocator;
 import org.kuali.rice.kim.bo.Person;
 import org.kuali.rice.kns.document.Document;
 import org.kuali.rice.kns.service.KNSServiceLocatorWeb;
 import org.kuali.rice.kns.workflow.service.KualiWorkflowDocument;
 
 /**
  * Base form for all <code>DocumentView</code> screens
  * 
  * @author Kuali Rice Team (rice.collab@kuali.org)
  */
 public class DocumentFormBase extends UifFormBase {
         private static final long serialVersionUID = 2190268505427404480L;
         
         private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DocumentFormBase.class);
 
         private String annotation = "";
         private String command;
 
         private String docId;
         private String docTypeName;
 
         protected Document document;
 
         public DocumentFormBase() {
             super();
             
             instantiateDocument();
         }
 
         public String getAnnotation() {
                 return this.annotation;
         }
 
         public void setAnnotation(String annotation) {
                 this.annotation = annotation;
         }
 
         public Document getDocument() {
                 return this.document;
         }
 
         public void setDocument(Document document) {
                 this.document = document;
         }
 
         public String getDocTypeName() {
                 return this.docTypeName;
         }
 
         public void setDocTypeName(String docTypeName) {
                 this.docTypeName = docTypeName;
         }
 
         public String getCommand() {
                 return this.command;
         }
 
         public void setCommand(String command) {
                 this.command = command;
         }
 
         public String getDocId() {
                 return this.docId;
         }
 
         public void setDocId(String docId) {
                 this.docId = docId;
         }
         
     protected String getDefaultDocumentTypeName() {
         return "";
     }
 
     protected void instantiateDocument() {
         if (document == null && StringUtils.isNotBlank(getDefaultDocumentTypeName())) {
             Class<? extends Document> documentClass = KNSServiceLocatorWeb.getDataDictionaryService()
                     .getDocumentClassByTypeName(getDefaultDocumentTypeName());
             try {
                 Document newDocument = documentClass.newInstance();
                 setDocument(newDocument);
             } catch (Exception e) {
                 LOG.error("Unable to instantiate document class " + documentClass.getName() + " document type "
                         + getDefaultDocumentTypeName());
                 throw new RuntimeException(e);
             }
         }
     }
 
         /**
          * Retrieves the principal name (network id) for the document's initiator
          * 
          * @return String initiator name
          */
         public String getDocumentInitiatorNetworkId() {
                 String initiatorNetworkId = "";
                 if (getWorkflowDocument() != null) {
                         String initiatorPrincipalId = getWorkflowDocument().getRouteHeader().getInitiatorPrincipalId();
                         Person initiator = KimApiServiceLocator.getPersonService().getPerson(initiatorPrincipalId);
                         if (initiator != null) {
                                 initiatorNetworkId = initiator.getPrincipalName();
                         }
                 }
 
                 return initiatorNetworkId;
         }
 
         /**
          * Retrieves the create date for the forms document and formats for
          * presentation
          * 
          * @return String formatted document create date
          */
         public String getDocumentCreateDate() {
                 String createDateStr = "";
                 if (getWorkflowDocument() != null && getWorkflowDocument().getCreateDate() != null) {
                         createDateStr = CoreApiServiceLocator.getDateTimeService().toString(getWorkflowDocument().getCreateDate(),
                                         "hh:mm a MM/dd/yyyy");
                 }
 
                 return createDateStr;
         }
 
         /**
          * Retrieves the <code>WorkflowDocument</code> instance from the forms
          * document instance
          * 
          * @return WorkflowDocument for the forms document
          */
         public KualiWorkflowDocument getWorkflowDocument() {
                 return getDocument().getDocumentHeader().getWorkflowDocument();
         }
 
 }

1		/*
2		* Copyright 2011 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 1.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/ecl1.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.web.spring.form;
17
18		import org.apache.commons.lang.StringUtils;
19		import org.kuali.rice.core.api.services.CoreApiServiceLocator;
20		import org.kuali.rice.kim.api.services.KimApiServiceLocator;
21		import org.kuali.rice.kim.bo.Person;
22		import org.kuali.rice.kns.document.Document;
23		import org.kuali.rice.kns.service.KNSServiceLocatorWeb;
24		import org.kuali.rice.kns.workflow.service.KualiWorkflowDocument;
25
26		/**
27		* Base form for all <code>DocumentView</code> screens
28		*
29		* @author Kuali Rice Team (rice.collab@kuali.org)
30		*/
31		public class DocumentFormBase extends UifFormBase {
32		private static final long serialVersionUID = 2190268505427404480L;
33
34	0	private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DocumentFormBase.class);
35
36	0	private String annotation = "";
37		private String command;
38
39		private String docId;
40		private String docTypeName;
41
42		protected Document document;
43
44		public DocumentFormBase() {
45	0	super();
46
47	0	instantiateDocument();
48	0	}
49
50		public String getAnnotation() {
51	0	return this.annotation;
52		}
53
54		public void setAnnotation(String annotation) {
55	0	this.annotation = annotation;
56	0	}
57
58		public Document getDocument() {
59	0	return this.document;
60		}
61
62		public void setDocument(Document document) {
63	0	this.document = document;
64	0	}
65
66		public String getDocTypeName() {
67	0	return this.docTypeName;
68		}
69
70		public void setDocTypeName(String docTypeName) {
71	0	this.docTypeName = docTypeName;
72	0	}
73
74		public String getCommand() {
75	0	return this.command;
76		}
77
78		public void setCommand(String command) {
79	0	this.command = command;
80	0	}
81
82		public String getDocId() {
83	0	return this.docId;
84		}
85
86		public void setDocId(String docId) {
87	0	this.docId = docId;
88	0	}
89
90		protected String getDefaultDocumentTypeName() {
91	0	return "";
92		}
93
94		protected void instantiateDocument() {
95	0	if (document == null && StringUtils.isNotBlank(getDefaultDocumentTypeName())) {
96	0	Class<? extends Document> documentClass = KNSServiceLocatorWeb.getDataDictionaryService()
97		.getDocumentClassByTypeName(getDefaultDocumentTypeName());
98		try {
99	0	Document newDocument = documentClass.newInstance();
100	0	setDocument(newDocument);
101	0	} catch (Exception e) {
102	0	LOG.error("Unable to instantiate document class " + documentClass.getName() + " document type "
103		+ getDefaultDocumentTypeName());
104	0	throw new RuntimeException(e);
105	0	}
106		}
107	0	}
108
109		/**
110		* Retrieves the principal name (network id) for the document's initiator
111		*
112		* @return String initiator name
113		*/
114		public String getDocumentInitiatorNetworkId() {
115	0	String initiatorNetworkId = "";
116	0	if (getWorkflowDocument() != null) {
117	0	String initiatorPrincipalId = getWorkflowDocument().getRouteHeader().getInitiatorPrincipalId();
118	0	Person initiator = KimApiServiceLocator.getPersonService().getPerson(initiatorPrincipalId);
119	0	if (initiator != null) {
120	0	initiatorNetworkId = initiator.getPrincipalName();
121		}
122		}
123
124	0	return initiatorNetworkId;
125		}
126
127		/**
128		* Retrieves the create date for the forms document and formats for
129		* presentation
130		*
131		* @return String formatted document create date
132		*/
133		public String getDocumentCreateDate() {
134	0	String createDateStr = "";
135	0	if (getWorkflowDocument() != null && getWorkflowDocument().getCreateDate() != null) {
136	0	createDateStr = CoreApiServiceLocator.getDateTimeService().toString(getWorkflowDocument().getCreateDate(),
137		"hh:mm a MM/dd/yyyy");
138		}
139
140	0	return createDateStr;
141		}
142
143		/**
144		* Retrieves the <code>WorkflowDocument</code> instance from the forms
145		* document instance
146		*
147		* @return WorkflowDocument for the forms document
148		*/
149		public KualiWorkflowDocument getWorkflowDocument() {
150	0	return getDocument().getDocumentHeader().getWorkflowDocument();
151		}
152
153		}