<commit_before>/*
 * Copyright 2005-2010 The Kuali Foundation
 * 
 * Licensed under the Educational Community License, Version 2.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.kra.irb.noteattachment;

import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;

import org.apache.ojb.broker.PersistenceBroker;
import org.apache.ojb.broker.PersistenceBrokerException;
import org.kuali.kra.SkipVersioning;
import org.kuali.kra.infrastructure.Constants;
import org.kuali.kra.infrastructure.KraServiceLocator;
import org.kuali.kra.irb.Protocol;
import org.kuali.rice.kns.service.DateTimeService;

/**
 * This class represents the Protocol Attachment Protocol.
 */
public class ProtocolAttachmentProtocol extends ProtocolAttachmentBase {

    private static final long serialVersionUID = -7115904344245464654L;
    private static final String GROUP_CODE = "1";
    
    private String statusCode;
    private ProtocolAttachmentStatus status;
    
    private String contactName;
    private String contactEmailAddress;
    private String contactPhoneNumber;
    private String comments;
    
    private String typeCode;
    private ProtocolAttachmentType type;
    private String description;
    private String documentStatusCode;
    private Integer attachmentVersion;
    private Timestamp createTimestamp;
    private List<ProtocolAttachmentProtocol> versions;
    
    private boolean active = true;
    private boolean changed = false;
    
    <commit_msg>kcirb-1262 : add documentation for some fields<commit_after>/*
 * Copyright 2005-2010 The Kuali Foundation
 * 
 * Licensed under the Educational Community License, Version 2.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.kra.irb.noteattachment;

import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;

import org.apache.ojb.broker.PersistenceBroker;
import org.apache.ojb.broker.PersistenceBrokerException;
import org.kuali.kra.SkipVersioning;
import org.kuali.kra.infrastructure.Constants;
import org.kuali.kra.infrastructure.KraServiceLocator;
import org.kuali.kra.irb.Protocol;
import org.kuali.rice.kns.service.DateTimeService;

/**
 * This class represents the Protocol Attachment Protocol.
 */
public class ProtocolAttachmentProtocol extends ProtocolAttachmentBase {

    private static final long serialVersionUID = -7115904344245464654L;
    private static final String GROUP_CODE = "1";
    
    // 1-Complete, 2-Incomplete.  an attachment status must be 'complete' before this protocol can be submitted.
    private String statusCode;
    private ProtocolAttachmentStatus status;
    
    private String contactName;
    private String contactEmailAddress;
    private String contactPhoneNumber;
    private String comments;
    
    private String typeCode;
    private ProtocolAttachmentType type;
    private String description;
    // documentstatuscode : 1-Draft, 2-Finalized, 3-Deleted
    // Alll new files are 'Draft'.  When protocol is approved, all 'Draft become 'Finalized'
    // 'delete' will set status to 'Deleted'.
    private String documentStatusCode;
    private Integer attachmentVersion;
    private Timestamp createTimestamp;
    private List<ProtocolAttachmentProtocol> versions;
    
    // an indicator to decide whether to display this file in protocol attachment panel or not
    private boolean active = true;
    // an indicator of whether this file has been changed/replaced or not.  This is if documentstatus is 1 or 3.
    // if it is changed, then the updateuser and updatetimestamp of this record will be updated.
    private boolean changed = false;
    
    
{'fraction_non_alphanumeric': 0.06697556866048862, 'fraction_numerical': 0.015374894692502106, 'mean_word_length': 4.073717948717949, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6650540', 'n_tokens_mistral': 1292, 'n_tokens_neox': 1245, 'n_words': 459}