001package com.github.theholywaffle.teamspeak3.api.wrapper;
002
003/*
004 * #%L
005 * TeamSpeak 3 Java API
006 * %%
007 * Copyright (C) 2018 Bert De Geyter, Roger Baumgartner
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
031/**
032 * Wrapper class for the result to a {@code customsearch} command.
033 */
034public class CustomPropertyAssignment extends Wrapper {
035
036        public CustomPropertyAssignment(Map<String, String> map) {
037                super(map);
038        }
039
040        /**
041         * Gets the database ID of the client that matched the custom client property search.
042         *
043         * @return the client's database ID
044         *
045         * @see Client#getDatabaseId()
046         */
047        public int getClientDatabaseId() {
048                return getInt("cldbid");
049        }
050
051        /**
052         * Gets the key of the matched custom client property.
053         *
054         * @return the key of the property
055         */
056        public String getKey() {
057                return get("ident");
058        }
059
060        /**
061         * Gets the value of the matched custom client property.
062         *
063         * @return the value of the property
064         */
065        public String getValue() {
066                return get("value");
067        }
068}