001package com.github.theholywaffle.teamspeak3.commands;
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 com.github.theholywaffle.teamspeak3.commands.parameter.KeyValueParam;
030
031/**
032 * Command to look up the value of a permission for the server query.
033 * <p>
034 * As this command returns both the numerical ID and the name of a permission,
035 * it is also useful for looking up a permission's ID based on its name
036 * and vice versa.
037 * </p>
038 */
039public class CPermGet extends Command {
040
041        /**
042         * Looks up a permission value based on the permission's name.
043         *
044         * @param permName
045         *              the name of the permission
046         */
047        public CPermGet(String permName) {
048                super("permget");
049                add(new KeyValueParam("permsid", permName));
050        }
051
052        /**
053         * Looks up a permission value based on the permission's numerical ID.
054         *
055         * @param permId
056         *              the ID of the permission
057         */
058        public CPermGet(int permId) {
059                super("permget");
060                add(new KeyValueParam("permid", permId));
061        }
062}