View Javadoc
1   /**
2    * Copyright 2014 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   *
15   * Created by Administrator on 2014/08/15
16   */
17  package org.kuali.student.enrollment.class1.hold.util;
18  
19  import org.kuali.student.core.person.service.PersonServiceNamespace;
20  
21  /**
22   * This class contains all the HoldIssue Constants
23   *
24   * @author Kuali Student Team
25   */
26  public class HoldsConstants {
27  
28  
29      public static final String NAMESPACE = "http://student.kuali.org/wsdl/HoldIssueAuthorizingOrgFacade";
30      public static final String SERVICE_NAME_LOCAL_PART = "HoldIssueAuthorizingOrgFacade";
31  
32      public static final String HOLD_ISSUE_DESCR_PLAIN = "descrPlain";
33      public static final String HOLD_ISSUE_SEARCH_ERROR_MSG = "Error Performing Search";
34      public static final String HOLD_ISSUE_PROCESS = "Process";
35  
36      public static final String HOLD_ISSUE_BASEURL = "holdIssueMaintenance";
37      public static final String APPLIED_HOLD_BASEURL = "appliedHoldMaintenance";
38  
39      public static final String HOLD_ISSUE_MAINTENANCE_VIEWNAME = "HoldIssueMaintenanceView";
40      public static final String APPLIED_HOLD_MAINTENANCE_VIEWNAME = "AppliedHoldMaintenanceView";
41  
42      public static final String APPLIED_HOLD_APPLY_PAGE_ID = "KS-ApplyHold-Page";
43      public static final String APPLIED_HOLD_EDIT_PAGE_ID = "KS-EditHold-Page";
44      public static final String APPLIED_HOLD_EXPIRE_PAGE_ID = "KS-ExpireHold-Page";
45      public static final String APPLIED_HOLD_DELETE_PAGE_ID = "KS-DeleteHold-Page";
46  
47      //Hold Issue Attributes
48      public static final String HOLD_ISSUE_ID = "id";
49      public static final String HOLD_ISSUE_NAME = "name";
50      public static final String HOLD_ISSUE_ORG_ID = "organizationId";
51      public static final String HOLD_ISSUE_ORG_NAME = "orgName";
52      public static final String HOLD_ISSUE_HOLD_CODE = "holdCode";
53      public static final String HOLD_ISSUE_TYPE_KEY = "typeKey";
54      public static final String HOLD_ISSUE_STATE_KEY = "stateKey";
55      public static final String HOLD_ISSUE_DESCT_DOT_PLAIN = "descr.plain";
56      public static final String HOLD_ISSUE_FIRST_APP_TERM_ID = "firstApplicationTermId";
57      public static final String HOLD_ISSUE_LAST_APP_TERM_ID = "lastApplicationTermId";
58      public static final String HOLD_ISSUE_FIRST_APPLIED_DATE = "firstAppliedDate";
59      public static final String HOLD_ISSUE_LAST_APPLIED_DATE = "lastAppliedDate";
60  
61      //Hold Issue property names
62      public static final String HOLDS_DATAOBJECT_PATH = "document.newMaintainableObject.dataObject";
63  
64      public static final String HOLD_ISSUE_PROP_NAME = "holdIssue";
65      public static final String HOLD_ISSUE_HOLDISSUE_PATH = HOLDS_DATAOBJECT_PATH + "." + HOLD_ISSUE_PROP_NAME;
66      public static final String HOLD_ISSUE_PROP_NAME_CODE = HOLD_ISSUE_HOLDISSUE_PATH + "." + HOLD_ISSUE_HOLD_CODE;
67  
68      public static final String HOLD_ISSUE_PROP_NAME_FIRST_APPLIED_DATE = HOLD_ISSUE_HOLDISSUE_PATH + "." + HOLD_ISSUE_FIRST_APPLIED_DATE;
69      public static final String HOLD_ISSUE_PROP_NAME_LAST_APPLIED_DATE = HOLD_ISSUE_HOLDISSUE_PATH + "." + HOLD_ISSUE_LAST_APPLIED_DATE;
70  
71      public static final String HOLD_ISSUE_PROP_NAME_FIRST_TERM = HOLDS_DATAOBJECT_PATH + "." + "firstTerm";
72      public static final String HOLD_ISSUE_PROP_NAME_LAST_TERM = HOLDS_DATAOBJECT_PATH + "." + "lastTerm";
73  
74      public static final String HOLD_ISSUE_PROP_NAME_AUTH_ORGS = HOLDS_DATAOBJECT_PATH + "." + "authorizedOrgs";
75      public static final String HOLD_ISSUE_PROP_NAME_AUTH_ORG_NAME = "name";
76  
77      //Applied Hold property names
78      public static final String APPLIED_HOLDS_PERSON_ID = "person.id";
79      public static final String APPLIED_HOLDS_EFFECTIVE_DATE = "effectiveDate";
80      public static final String APPLIED_HOLDS_EFFECTIVE_TERM = "effectiveTerm";
81      public static final String APPLIED_HOLDS_EXPIRATION_DATE = "expirationDate";
82      public static final String APPLIED_HOLDS_EXPIRATION_TERM = "expirationTerm";
83      public static final String APPLIED_HOLDS_PROP_NAME = "appliedHold";
84      public static final String APPLIED_HOLDS_PATH = HOLDS_DATAOBJECT_PATH;
85      public static final String APPLIED_HOLDS_PROP_NAME_CODE =  APPLIED_HOLDS_PATH + "." + HOLD_ISSUE_HOLD_CODE;
86      public static final String APPLIED_HOLDS_PROP_NAME_EFFECTIVE_TERM = APPLIED_HOLDS_PATH + "." + APPLIED_HOLDS_EFFECTIVE_TERM;
87      public static final String APPLIED_HOLDS_PROP_NAME_EFFECTIVE_DATE = APPLIED_HOLDS_PATH + "." + APPLIED_HOLDS_PROP_NAME +"."+APPLIED_HOLDS_EFFECTIVE_DATE;
88      public static final String APPLIED_HOLDS_PROP_NAME_EXPIRATION_TERM = APPLIED_HOLDS_PATH + "." + APPLIED_HOLDS_EXPIRATION_TERM;
89      public static final String APPLIED_HOLDS_PROP_NAME_EXPIRATION_DATE = APPLIED_HOLDS_PATH + "." + APPLIED_HOLDS_PROP_NAME +"."+APPLIED_HOLDS_EXPIRATION_DATE;
90  
91      //success Message keys
92      public static final String HOLDS_ISSUE_MSG_SUCCESS_HOLD_ISSUE_CREATED = "success.hold.issue.created";
93      public static final String HOLDS_ISSUE_MSG_SUCCESS_HOLD_ISSUE_EDITED = "success.hold.issue.edited";
94      public static final String APPLIED_HOLDS_MSG_SUCCESS_HOLD_APPLIED = "success.applied.hold.applied";
95      public static final String APPLIED_HOLDS_MSG_SUCCESS_HOLD_EXPIRED = "success.applied.hold.expired";
96      public static final String APPLIED_HOLDS_MSG_SUCCESS_HOLD_DELETED = "success.applied.hold.deleted";
97  
98      //error Message keys
99      public static final String HOLDS_ISSUE_MSG_ERROR_HOLD_ISSUE_NAME_REQUIRED = "error.hold.issue.name.required";
100     public static final String HOLDS_ISSUE_MSG_ERROR_HOLD_ISSUE_TYPE_REQUIRED = "error.hold.issue.type.required";
101     public static final String HOLDS_ISSUE_MSG_ERROR_HOLD_ISSUE_ORG_ID_REQUIRED = "error.hold.issue.orgId.required";
102     public static final String HOLDS_ISSUE_MSG_ERROR_HOLD_ISSUE_CODE_REQUIRED = "error.hold.issue.code.required";
103     public static final String HOLDS_ISSUE_MSG_ERROR_HOLDCODE_ALREADY_EXISTS = "error.hold.issue.code.exist";
104     public static final String HOLDS_ISSUE_MSG_ERROR_FIRST_APPLICATION_TERMID = "error.hold.issue.first.application.term.id";
105     public static final String HOLDS_ISSUE_MSG_ERROR_LAST_APPLICATION_TERMID = "error.hold.issue.last.application.term.id";
106     public static final String HOLDS_ISSUE_MSG_ERROR_INVALID_DATE_RANGE = "error.hold.daterange.invalid";
107     public static final String HOLDS_ISSUE_MSG_ERROR_INVALID_DATE_RANGE_LAST_APPLIED_DATE = "error.hold.daterange.last.applied.date.invalid";
108     public static final String HOLDS_ISSUE_MSG_ERROR_AUTHORIZED_ORG = "error.hold.issue.org.no.permission.selected";
109     public static final String HOLDS_ISSUE_MSG_ERROR_AUTHORIZED_ORG_REQUIRED = "error.hold.issue.org.required";
110     public static final String HOLDS_ISSUE_MSG_ERROR_AUTHORIZED_ORG_DUPLICATE = "error.hold.issue.org.duplicate";
111     public static final String HOLDS_ISSUE_MSG_ERROR_INVALID_TERM = "error.hold.issue.term.invalid";
112     public static final String HOLDS_ISSUE_MSG_ERROR_FIRST_TERM_REQUIRED = "error.hold.issue.first.term.required";
113     public static final String HOLDS_ISSUE_MSG_ERROR_INVALID_TERM_STATE = "error.hold.issue.term.state.invalid";
114 
115     //applied holds error msg
116     public static final String APPLIED_HOLDS_MSG_ERROR_STUDENT_REQUIRED = "error.admin.reg.studentId.required";
117     public static final String APPLIED_HOLDS_MSG_ERROR_INVALID_STUDENT = "error.admin.reg.studentId.invalid";
118     public static final String APPLIED_HOLDS_MSG_ERROR_NO_STUDENT_AFFILIATION = "error.admin.reg.studentId.no.affiliation";
119     public static final String APPLIED_HOLDS_MSG_ERROR_HOLD_CODE_INVALID = "error.hold.issue.applied.code.invalid";
120     public static final String APPLIED_HOLDS_MSG_ERROR_ACTIVE_HOLD_CODE_ALREADY_APPLIED = "error.hold.issue.applied.active.exist";
121     public static final String APPLIED_HOLDS_MSG_ERROR_EXISTING_HOLD_CODE_INVALID_DATE_RANGE = "error.hold.issue.applied.code.exist.daterange.invalid";
122     public static final String APPLIED_HOLDS_MSG_ERROR_EFFECTIVE_TERM_REQUIRED = "error.hold.issue.applied.first.term.required";
123     public static final String APPLIED_HOLDS_MSG_ERROR_EFFECTIVE_DATE_REQUIRED = "error.hold.issue.applied.first.date.required";
124     public static final String APPLIED_HOLDS_MSG_ERROR_UNAUTHORIZED_APPLY = "error.hold.issue.applied.unauthorized.apply";
125     public static final String APPLIED_HOLDS_MSG_ERROR_UNAUTHORIZED_EXPIRE = "error.hold.issue.applied.unauthorized.expire";
126     public static final String APPLIED_HOLDS_MSG_ERROR_UNAUTHORIZED_DELETE = "error.hold.issue.applied.unauthorized.delete";
127     public static final String APPLIED_HOLDS_MSG_ERROR_EFFECTIVE_TERM_AFTER_INVALID_DATE_RANGE = "error.hold.issue.applied.effective.term.afterrange.invalid";
128     public static final String APPLIED_HOLDS_MSG_ERROR_EFFECTIVE_TERM_BEFORE_INVALID_DATE_RANGE = "error.hold.issue.applied.effective.term.beforerange.invalid";
129     public static final String APPLIED_HOLDS_MSG_ERROR_EXPIRATION_TERM_AFTER_INVALID_DATE_RANGE= "error.hold.issue.applied.expiration.term.afterrange.invalid";
130     public static final String APPLIED_HOLDS_MSG_ERROR_EXPIRATION_TERM_BEFORE_INVALID_DATE_RANGE= "error.hold.issue.applied.expiration.term.beforerange.invalid";
131     public static final String APPLIED_HOLDS_MSG_ERROR_EFFECTIVE_DATE_AFTER_INVALID_DATE_RANGE = "error.hold.issue.applied.effective.date.afterrange.invalid";
132     public static final String APPLIED_HOLDS_MSG_ERROR_EFFECTIVE_DATE_BEFORE_INVALID_DATE_RANGE = "error.hold.issue.applied.effective.date.beforerange.invalid";
133     public static final String APPLIED_HOLDS_MSG_ERROR_EXPIRATION_DATE_AFTER_INVALID_DATE_RANGE = "error.hold.issue.applied.expiration.date.afterrange.invalid";
134     public static final String APPLIED_HOLDS_MSG_ERROR_EXPIRATION_DATE_BEFORE_INVALID_DATE_RANGE = "error.hold.issue.applied.expiration.date.beforerange.invalid";
135     public static final String APPLIED_HOLDS_MSG_ERROR_EXPIRATION_TERMEFFECTIVE_BEFORE_INVALID_TERM_RANGE= "error.hold.issue.applied.expiration.term.effective.beforerange.invalid";
136 
137     //applied hold actions
138     public static final String APPLIED_HOLDS_ACTION_APPLY = "kuali.applied.hold.apply";
139     public static final String APPLIED_HOLDS_ACTION_EDIT = "kuali.applied.hold.edit";
140     public static final String APPLIED_HOLDS_ACTION_EXPIRE = "kuali.applied.hold.expire";
141     public static final String APPLIED_HOLDS_ACTION_DELETE = "kuali.applied.hold.delete";
142 
143     //info Message keys
144     public static final String HOLDS_ISSUE_MSG_INFO_HOLD_ISSUE_SAVE_SUCCESS = "info.enroll.save.success";
145 
146     //workflow
147     public static final String NEW_HOLD_ISSUE_DOCUMENT_TEXT = "New Hold Issue Document";
148     public static final String MODIFY_HOLD_ISSUE_DOCUMENT_TEXT = "Modify Hold Issue Document";
149 
150     //Permissions
151     public static final String APPLY_HOLD_ROLE_PERMISSION = "Hold Apply Hold Role";
152     public static final String EXPIRE_APPLIED_HOLD_ROLE_PERMISSION = "Hold Expire Applied Hold Role";
153     public static final String APPLIED_HOLD_ACTION_EVENT_APPLY_HOLD = "Apply Hold";
154     public static final String APPLIED_HOLD_ACTION_EVENT_EXPIRE_HOLD = "Expire Hold";
155 
156     //Holds Url parameters
157     public static final String HOLDS_URL_PARAMETERS_ACTION = "action";
158     public static final String HOLDS_URL_PARAMETERS_APPLIED_HOLD_ID = "appliedHoldId";
159     public static final String HOLDS_URL_PARAMETERS_PERSON_ID = "personId";
160 
161 }