com.aoindustries.aoserv.client.ticket.Action Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aoserv-client Show documentation
Show all versions of aoserv-client Show documentation
Java client for the AOServ Platform.
/*
* aoserv-client - Java client for the AOServ Platform.
* Copyright (C) 2001-2013, 2016, 2017, 2018, 2019 AO Industries, Inc.
* [email protected]
* 7262 Bull Pen Cir
* Mobile, AL 36695
*
* This file is part of aoserv-client.
*
* aoserv-client is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* aoserv-client is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with aoserv-client. If not, see TicketActions represent a complete history of the changes that have been made to a ticket.
* When a ticket is initially created it has no actions. Any change from its initial state will cause
* an action to be logged.
*
* @see Ticket
*
* @author AO Industries, Inc.
*/
final public class Action extends CachedObjectIntegerKey {
static final int
COLUMN_PKEY=0,
COLUMN_TICKET=1,
COLUMN_ADMINISTRATOR=2,
COLUMN_TIME=3
;
static final String COLUMN_TICKET_name = "ticket";
static final String COLUMN_TIME_name = "time";
static final String COLUMN_PKEY_name = "pkey";
private int ticket;
private User.Name administrator;
private UnmodifiableTimestamp time;
private String action_type;
private Account.Name old_accounting;
private Account.Name new_accounting;
private String old_priority;
private String new_priority;
private String old_type;
private String new_type;
private String old_status;
private String new_status;
private User.Name old_assigned_to;
private User.Name new_assigned_to;
private int old_category;
private int new_category;
private boolean oldValueLoaded;
private String old_value;
private boolean newValueLoaded;
private String new_value;
private Email from_address;
private String summary;
private boolean detailsLoaded;
private String details;
private boolean rawEmailLoaded;
private String raw_email;
@Override
protected Object getColumnImpl(int i) throws IOException, SQLException {
switch(i) {
case COLUMN_PKEY: return pkey;
case COLUMN_TICKET: return ticket;
case COLUMN_ADMINISTRATOR: return administrator;
case COLUMN_TIME: return time;
case 4: return action_type;
case 5: return old_accounting;
case 6: return new_accounting;
case 7: return old_priority;
case 8: return new_priority;
case 9: return old_type;
case 10: return new_type;
case 11: return old_status;
case 12: return new_status;
case 13: return old_assigned_to;
case 14: return new_assigned_to;
case 15: return old_category==-1 ? null : old_category;
case 16: return new_category==-1 ? null : new_category;
case 17: return getOldValue();
case 18: return getNewValue();
case 19: return from_address;
case 20: return summary;
case 21: return getDetails();
case 22: return getRawEmail();
default: throw new IllegalArgumentException("Invalid index: " + i);
}
}
public Ticket getTicket() throws IOException, SQLException {
Ticket t = table.getConnector().getTicket().getTicket().get(ticket);
if(t==null) throw new SQLException("Unable to find Ticket: "+ticket);
return t;
}
public Administrator getAdministrator() throws IOException, SQLException {
if(administrator==null) return null;
return table.getConnector().getAccount().getAdministrator().get(administrator);
}
public UnmodifiableTimestamp getTime() {
return time;
}
public ActionType getTicketActionType() throws SQLException, IOException {
ActionType type=table.getConnector().getTicket().getActionType().get(action_type);
if(type==null) throw new SQLException("Unable to find TicketActionType: "+action_type);
return type;
}
/**
* May be null due to filtering
*/
public Account getOldAccount() throws IOException, SQLException {
if(old_accounting==null) return null;
return table.getConnector().getAccount().getAccount().get(old_accounting);
}
/**
* May be null due to filtering
*/
public Account getNewAccount() throws IOException, SQLException {
if(new_accounting==null) return null;
return table.getConnector().getAccount().getAccount().get(new_accounting);
}
public Priority getOldPriority() throws IOException, SQLException {
if(old_priority==null) return null;
Priority tp = table.getConnector().getTicket().getPriority().get(old_priority);
if(tp==null) throw new SQLException("Unable to find TicketPriority: "+old_priority);
return tp;
}
public Priority getNewPriority() throws IOException, SQLException {
if(new_priority==null) return null;
Priority tp = table.getConnector().getTicket().getPriority().get(new_priority);
if(tp==null) throw new SQLException("Unable to find TicketPriority: "+new_priority);
return tp;
}
public TicketType getOldType() throws IOException, SQLException {
if(old_type==null) return null;
TicketType tt = table.getConnector().getTicket().getTicketType().get(old_type);
if(tt==null) throw new SQLException("Unable to find TicketType: "+old_type);
return tt;
}
public TicketType getNewType() throws IOException, SQLException {
if(new_type==null) return null;
TicketType tt = table.getConnector().getTicket().getTicketType().get(new_type);
if(tt==null) throw new SQLException("Unable to find TicketType: "+new_type);
return tt;
}
public Status getOldStatus() throws IOException, SQLException {
if(old_status==null) return null;
Status ts = table.getConnector().getTicket().getStatus().get(old_status);
if(ts==null) throw new SQLException("Unable to find TicketStatus: "+old_status);
return ts;
}
public Status getNewStatus() throws IOException, SQLException {
if(new_status==null) return null;
Status ts = table.getConnector().getTicket().getStatus().get(new_status);
if(ts==null) throw new SQLException("Unable to find TicketStatus: "+new_status);
return ts;
}
/**
* May be null due to filtering
*/
public Administrator getOldAssignedTo() throws IOException, SQLException {
if(old_assigned_to==null) return null;
return table.getConnector().getAccount().getAdministrator().get(old_assigned_to);
}
/**
* May be null due to filtering
*/
public Administrator getNewAssignedTo() throws IOException, SQLException {
if(new_assigned_to==null) return null;
return table.getConnector().getAccount().getAdministrator().get(new_assigned_to);
}
public Category getOldCategory() throws IOException, SQLException {
if(old_category==-1) return null;
Category tc = table.getConnector().getReseller().getCategory().get(old_category);
if(tc==null) throw new SQLException("Unable to find TicketCategory: "+old_category);
return tc;
}
public Category getNewCategory() throws IOException, SQLException {
if(new_category==-1) return null;
Category tc = table.getConnector().getReseller().getCategory().get(new_category);
if(tc==null) throw new SQLException("Unable to find TicketCategory: "+new_category);
return tc;
}
synchronized public String getOldValue() throws IOException, SQLException {
if(!oldValueLoaded) {
// Only perform the query for action types that have old values
if(
action_type.equals(ActionType.SET_CONTACT_EMAILS)
|| action_type.equals(ActionType.SET_CONTACT_PHONE_NUMBERS)
|| action_type.equals(ActionType.SET_SUMMARY)
|| action_type.equals(ActionType.SET_INTERNAL_NOTES)
) {
old_value = table.getConnector().requestNullLongStringQuery(true, AoservProtocol.CommandID.GET_TICKET_ACTION_OLD_VALUE, pkey);
} else {
old_value = null;
}
oldValueLoaded = true;
}
return old_value;
}
synchronized public String getNewValue() throws IOException, SQLException {
if(!newValueLoaded) {
// Only perform the query for action types that have new values
if(
action_type.equals(ActionType.SET_CONTACT_EMAILS)
|| action_type.equals(ActionType.SET_CONTACT_PHONE_NUMBERS)
|| action_type.equals(ActionType.SET_SUMMARY)
|| action_type.equals(ActionType.SET_INTERNAL_NOTES)
) {
new_value = table.getConnector().requestNullLongStringQuery(true, AoservProtocol.CommandID.GET_TICKET_ACTION_NEW_VALUE, pkey);
} else {
new_value = null;
}
newValueLoaded = true;
}
return new_value;
}
public Email getFromAddress() {
return from_address;
}
/**
* Gets the summary for the provided Locale, may be generated for certain action types.
*/
public String getSummary() throws IOException, SQLException {
if(summary!=null) return summary;
final String oldValue;
final String newValue;
if(action_type.equals(ActionType.SET_BUSINESS)) {
oldValue = Objects.toString(old_accounting, null);
newValue = Objects.toString(new_accounting, null);
} else if(
action_type.equals(ActionType.SET_CLIENT_PRIORITY)
|| action_type.equals(ActionType.SET_ADMIN_PRIORITY)
) {
oldValue = old_priority;
newValue = new_priority;
} else if(action_type.equals(ActionType.SET_TYPE)) {
oldValue = getOldType().toStringImpl();
newValue = getNewType().toStringImpl();
} else if(action_type.equals(ActionType.SET_STATUS)) {
oldValue = getOldStatus().toStringImpl();
newValue = getNewStatus().toStringImpl();
} else if(action_type.equals(ActionType.ASSIGN)) {
Administrator oldAssignedTo = getOldAssignedTo();
Administrator newAssignedTo = getNewAssignedTo();
oldValue = oldAssignedTo!=null ? oldAssignedTo.getName() : old_assigned_to!=null ? accessor.getMessage("TicketAction.old_assigned_to.filtered") : null;
newValue = newAssignedTo!=null ? newAssignedTo.getName() : new_assigned_to!=null ? accessor.getMessage("TicketAction.new_assigned_to.filtered") : null;
} else if(action_type.equals(ActionType.SET_CATEGORY)) {
Category oldCategory = getOldCategory();
Category newCategory = getNewCategory();
oldValue = oldCategory!=null ? oldCategory.toStringImpl() : null;
newValue = newCategory!=null ? newCategory.toStringImpl() : null;
} else if(
action_type.equals(ActionType.SET_CONTACT_EMAILS)
|| action_type.equals(ActionType.SET_CONTACT_PHONE_NUMBERS)
|| action_type.equals(ActionType.SET_SUMMARY)
|| action_type.equals(ActionType.SET_INTERNAL_NOTES)
|| action_type.equals(ActionType.ADD_ANNOTATION)
) {
// These either have no old/new value or their value is not altered in any way
oldValue = getOldValue();
newValue = getNewValue();
} else {
throw new SQLException("Unexpected value for action_type: "+action_type);
}
return getTicketActionType().generateSummary(table.getConnector(), oldValue, newValue);
}
synchronized public String getDetails() throws IOException, SQLException {
if(!detailsLoaded) {
// Only perform the query for action types that have details
if(action_type.equals(ActionType.ADD_ANNOTATION)) {
details = table.getConnector().requestNullLongStringQuery(true, AoservProtocol.CommandID.GET_TICKET_ACTION_DETAILS, pkey);
} else {
details = null;
}
detailsLoaded = true;
}
return details;
}
synchronized public String getRawEmail() throws IOException, SQLException {
if(!rawEmailLoaded) {
// Only perform the query for action types that may have raw email
if(action_type.equals(ActionType.ADD_ANNOTATION)) {
raw_email = table.getConnector().requestNullLongStringQuery(true, AoservProtocol.CommandID.GET_TICKET_ACTION_RAW_EMAIL, pkey);
} else {
raw_email = null;
}
rawEmailLoaded = true;
}
return raw_email;
}
@Override
public Table.TableID getTableID() {
return Table.TableID.TICKET_ACTIONS;
}
@Override
public void init(ResultSet result) throws SQLException {
try {
int pos = 1;
pkey = result.getInt(pos++);
ticket = result.getInt(pos++);
administrator = User.Name.valueOf(result.getString(pos++));
time = UnmodifiableTimestamp.valueOf(result.getTimestamp(pos++));
action_type = result.getString(pos++);
old_accounting = Account.Name.valueOf(result.getString(pos++));
new_accounting = Account.Name.valueOf(result.getString(pos++));
old_priority = result.getString(pos++);
new_priority = result.getString(pos++);
old_type = result.getString(pos++);
new_type = result.getString(pos++);
old_status = result.getString(pos++);
new_status = result.getString(pos++);
old_assigned_to = User.Name.valueOf(result.getString(pos++));
new_assigned_to = User.Name.valueOf(result.getString(pos++));
old_category = result.getInt(pos++);
if(result.wasNull()) old_category = -1;
new_category = result.getInt(pos++);
if(result.wasNull()) new_category = -1;
// Loaded only when needed: old_value = result.getString(pos++);
// Loaded only when needed: new_value = result.getString(pos++);
from_address = Email.valueOf(result.getString(pos++));
summary = result.getString(pos++);
// Loaded only when needed: details = result.getString(pos++);
// Loaded only when needed: raw_email = result.getString(pos++);
} catch(ValidationException e) {
throw new SQLException(e);
}
}
@Override
public void read(StreamableInput in, AoservProtocol.Version protocolVersion) throws IOException {
try {
pkey = in.readCompressedInt();
ticket = in.readCompressedInt();
administrator = InternUtils.intern(User.Name.valueOf(in.readNullUTF()));
time = in.readUnmodifiableTimestamp();
action_type = in.readUTF().intern();
old_accounting = InternUtils.intern(Account.Name.valueOf(in.readNullUTF()));
new_accounting = InternUtils.intern(Account.Name.valueOf(in.readNullUTF()));
old_priority = InternUtils.intern(in.readNullUTF());
new_priority = InternUtils.intern(in.readNullUTF());
old_type = InternUtils.intern(in.readNullUTF());
new_type = InternUtils.intern(in.readNullUTF());
old_status = InternUtils.intern(in.readNullUTF());
new_status = InternUtils.intern(in.readNullUTF());
old_assigned_to = InternUtils.intern(User.Name.valueOf(in.readNullUTF()));
new_assigned_to = InternUtils.intern(User.Name.valueOf(in.readNullUTF()));
old_category = in.readCompressedInt();
new_category = in.readCompressedInt();
// Loaded only when needed: old_value
// Loaded only when needed: new_value
from_address = Email.valueOf(in.readNullUTF());
summary = in.readNullUTF();
// Loaded only when needed: details
// Loaded only when needed: raw_email
} catch(ValidationException e) {
throw new IOException(e);
}
}
@Override
public String toStringImpl() {
return ticket+"|"+pkey+'|'+action_type+'|'+administrator;
}
@Override
public void write(StreamableOutput out, AoservProtocol.Version protocolVersion) throws IOException {
out.writeCompressedInt(pkey);
out.writeCompressedInt(ticket);
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_50)>=0) out.writeNullUTF(Objects.toString(administrator, null));
else out.writeUTF(administrator==null ? "aoadmin" : administrator.toString());
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_83_0) < 0) {
out.writeLong(time.getTime());
} else {
out.writeTimestamp(time);
}
out.writeUTF(action_type);
out.writeNullUTF(Objects.toString(old_accounting, null));
out.writeNullUTF(Objects.toString(new_accounting, null));
out.writeNullUTF(old_priority);
out.writeNullUTF(new_priority);
if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_49)>=0) {
out.writeNullUTF(old_type);
out.writeNullUTF(new_type);
}
out.writeNullUTF(old_status);
out.writeNullUTF(new_status);
out.writeNullUTF(Objects.toString(old_assigned_to, null));
out.writeNullUTF(Objects.toString(new_assigned_to, null));
out.writeCompressedInt(old_category);
out.writeCompressedInt(new_category);
// Loaded only when needed: old_value
// Loaded only when needed: new_value
out.writeNullUTF(Objects.toString(from_address, null));
out.writeNullUTF(summary);
// Loaded only when needed: details
// Loaded only when needed: raw_email
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy