001package com.github.theholywaffle.teamspeak3.api.wrapper;
002
003/*
004 * #%L
005 * TeamSpeak 3 Java API
006 * %%
007 * Copyright (C) 2014 Bert De Geyter
008 * %%
009 * Permission is hereby granted, free of charge, to any person obtaining a copy
010 * of this software and associated documentation files (the "Software"), to deal
011 * in the Software without restriction, including without limitation the rights
012 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
013 * copies of the Software, and to permit persons to whom the Software is
014 * furnished to do so, subject to the following conditions:
015 * 
016 * The above copyright notice and this permission notice shall be included in
017 * all copies or substantial portions of the Software.
018 * 
019 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
020 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
021 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
022 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
023 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
024 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
025 * THE SOFTWARE.
026 * #L%
027 */
028
029import java.util.Map;
030
031public class QueryError extends Wrapper {
032
033        private static final int ERROR_ID_OK = 0;
034        private static final int ERROR_ID_EMPTY_RESULT_SET = 1281;
035
036        public QueryError(Map<String, String> map) {
037                super(map);
038        }
039
040        public int getId() {
041                return getInt("id");
042        }
043
044        public String getMessage() {
045                return get("msg");
046        }
047
048        public String getExtraMessage() {
049                return get("extra_msg");
050        }
051
052        public int getFailedPermissionId() {
053                return getInt("failed_permid");
054        }
055
056        public boolean isSuccessful() {
057                final int id = getId();
058                return (id == ERROR_ID_OK || id == ERROR_ID_EMPTY_RESULT_SET);
059        }
060}