Revision 2097
Added by Matt Jones over 20 years ago
| src/edu/ucsb/nceas/metacat/EventLogData.java | ||
|---|---|---|
| 24 | 24 |
package edu.ucsb.nceas.metacat; |
| 25 | 25 |
|
| 26 | 26 |
/** |
| 27 |
* A data structure holding the information to be logged about an event. |
|
| 28 |
* |
|
| 29 |
* TODO: add a timestamp field for when the event occurred. |
|
| 30 |
* |
|
| 27 | 31 |
* @author jones |
| 28 |
* |
|
| 29 |
* TODO To change the template for this generated type comment go to |
|
| 30 |
* Window - Preferences - Java - Code Generation - Code and Comments |
|
| 31 | 32 |
*/ |
| 32 | 33 |
public class EventLogData {
|
| 33 | 34 |
private String ipAddress; |
| ... | ... | |
| 38 | 39 |
|
| 39 | 40 |
|
| 40 | 41 |
/** |
| 41 |
* @param ipAddress |
|
| 42 |
* @param principal |
|
| 43 |
* @param docid |
|
| 44 |
* @param revision |
|
| 45 |
* @param event |
|
| 42 |
* Construct an EventLogData object with event log information. |
|
| 43 |
* |
|
| 44 |
* @param ipAddress the internet protocol address for the event |
|
| 45 |
* @param principal the principal for the event (a username, etc) |
|
| 46 |
* @param docid the identifier of the document to which the event applies |
|
| 47 |
* @param revision the revision of the document to which the event applies |
|
| 48 |
* @param event the string code for the event |
|
| 46 | 49 |
*/ |
| 47 | 50 |
public EventLogData(String ipAddress, String principal, String docid, |
| 48 | 51 |
long revision, String event) {
|
| ... | ... | |
| 54 | 57 |
} |
| 55 | 58 |
|
| 56 | 59 |
/** |
| 60 |
* Get the current value of the document identifier. |
|
| 57 | 61 |
* @return Returns the docid. |
| 58 | 62 |
*/ |
| 59 | 63 |
public String getDocid() {
|
| ... | ... | |
| 61 | 65 |
} |
| 62 | 66 |
|
| 63 | 67 |
/** |
| 68 |
* Set the document identifier. |
|
| 69 |
* |
|
| 64 | 70 |
* @param docid The docid to set. |
| 65 | 71 |
*/ |
| 66 | 72 |
public void setDocid(String docid) {
|
| ... | ... | |
| 68 | 74 |
} |
| 69 | 75 |
|
| 70 | 76 |
/** |
| 77 |
* Get the current value of the event. |
|
| 78 |
* |
|
| 71 | 79 |
* @return Returns the event. |
| 72 | 80 |
*/ |
| 73 | 81 |
public String getEvent() {
|
| ... | ... | |
| 75 | 83 |
} |
| 76 | 84 |
|
| 77 | 85 |
/** |
| 86 |
* Set the current value of the event. |
|
| 87 |
* |
|
| 78 | 88 |
* @param event The event to set. |
| 79 | 89 |
*/ |
| 80 | 90 |
public void setEvent(String event) {
|
| ... | ... | |
| 82 | 92 |
} |
| 83 | 93 |
|
| 84 | 94 |
/** |
| 95 |
* Get the current value of the internet protocol address. |
|
| 96 |
* |
|
| 85 | 97 |
* @return Returns the ipAddress. |
| 86 | 98 |
*/ |
| 87 | 99 |
public String getIpAddress() {
|
| ... | ... | |
| 89 | 101 |
} |
| 90 | 102 |
|
| 91 | 103 |
/** |
| 104 |
* Set the current value of the internet protocol address. |
|
| 105 |
* |
|
| 92 | 106 |
* @param ipAddress The ipAddress to set. |
| 93 | 107 |
*/ |
| 94 | 108 |
public void setIpAddress(String ipAddress) {
|
| ... | ... | |
| 96 | 110 |
} |
| 97 | 111 |
|
| 98 | 112 |
/** |
| 113 |
* Get the current value of the principal. This will be a username or |
|
| 114 |
* other user identifier. |
|
| 115 |
* |
|
| 99 | 116 |
* @return Returns the principal. |
| 100 | 117 |
*/ |
| 101 | 118 |
public String getPrincipal() {
|
| ... | ... | |
| 103 | 120 |
} |
| 104 | 121 |
|
| 105 | 122 |
/** |
| 123 |
* Set the current value of the principal. This will be a username or |
|
| 124 |
* other user identifier. |
|
| 125 |
* |
|
| 106 | 126 |
* @param principal The principal to set. |
| 107 | 127 |
*/ |
| 108 | 128 |
public void setPrincipal(String principal) {
|
| ... | ... | |
| 110 | 130 |
} |
| 111 | 131 |
|
| 112 | 132 |
/** |
| 133 |
* Get the current value of the document revision. |
|
| 134 |
* |
|
| 113 | 135 |
* @return Returns the revision. |
| 114 | 136 |
*/ |
| 115 | 137 |
public long getRevision() {
|
| ... | ... | |
| 117 | 139 |
} |
| 118 | 140 |
|
| 119 | 141 |
/** |
| 142 |
* Set the current value of the document revision. |
|
| 143 |
* |
|
| 120 | 144 |
* @param revision The revision to set. |
| 121 | 145 |
*/ |
| 122 | 146 |
public void setRevision(long revision) {
|
Also available in: Unified diff
Added javadoc that was missing for the EventLogData class.