001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.sec.businessobject;
017    
018    import java.util.LinkedHashMap;
019    
020    import org.kuali.kfs.sec.SecPropertyConstants;
021    import org.kuali.kfs.sys.KFSPropertyConstants;
022    import org.kuali.rice.kns.bo.TransientBusinessObjectBase;
023    
024    
025    /**
026     * Holds information regarding an access restriction that was found. Used by AccessSecurityService to provide information back when checking access
027     */
028    public class AccessSecurityRestrictionInfo extends TransientBusinessObjectBase {
029        private String securityAttributeName;
030        private String propertyName;
031        private String propertyLabel;
032        private String retrictedValue;
033        private String documentNumber;
034    
035        public AccessSecurityRestrictionInfo() {
036    
037        }
038    
039        /**
040         * Gets the securityAttributeName attribute.
041         * 
042         * @return Returns the securityAttributeName.
043         */
044        public String getSecurityAttributeName() {
045            return securityAttributeName;
046        }
047    
048    
049        /**
050         * Sets the securityAttributeName attribute value.
051         * 
052         * @param securityAttributeName The securityAttributeName to set.
053         */
054        public void setSecurityAttributeName(String securityAttributeName) {
055            this.securityAttributeName = securityAttributeName;
056        }
057    
058    
059        /**
060         * Gets the propertyName attribute.
061         * 
062         * @return Returns the propertyName.
063         */
064        public String getPropertyName() {
065            return propertyName;
066        }
067    
068    
069        /**
070         * Sets the propertyName attribute value.
071         * 
072         * @param propertyName The propertyName to set.
073         */
074        public void setPropertyName(String propertyName) {
075            this.propertyName = propertyName;
076        }
077    
078    
079        /**
080         * Gets the retrictedValue attribute.
081         * 
082         * @return Returns the retrictedValue.
083         */
084        public String getRetrictedValue() {
085            return retrictedValue;
086        }
087    
088    
089        /**
090         * Sets the retrictedValue attribute value.
091         * 
092         * @param retrictedValue The retrictedValue to set.
093         */
094        public void setRetrictedValue(String retrictedValue) {
095            this.retrictedValue = retrictedValue;
096        }
097    
098    
099        /**
100         * Gets the propertyLabel attribute.
101         * 
102         * @return Returns the propertyLabel.
103         */
104        public String getPropertyLabel() {
105            return propertyLabel;
106        }
107    
108        /**
109         * Sets the propertyLabel attribute value.
110         * 
111         * @param propertyLabel The propertyLabel to set.
112         */
113        public void setPropertyLabel(String propertyLabel) {
114            this.propertyLabel = propertyLabel;
115        }
116    
117    
118        /**
119         * Gets the documentNumber attribute.
120         * 
121         * @return Returns the documentNumber.
122         */
123        public String getDocumentNumber() {
124            return documentNumber;
125        }
126    
127        /**
128         * Sets the documentNumber attribute value.
129         * 
130         * @param documentNumber The documentNumber to set.
131         */
132        public void setDocumentNumber(String documentNumber) {
133            this.documentNumber = documentNumber;
134        }
135    
136        
137        protected LinkedHashMap toStringMapper() {
138            LinkedHashMap m = new LinkedHashMap();
139    
140            m.put(SecPropertyConstants.SECURITY_ATTRIBUTE_NAME, this.securityAttributeName);
141    
142            return m;
143        }
144    
145    }