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
031/**
032 * Describes a single permission on the TS3 server.
033 * <p>
034 * Includes the numerical ID and the name of the permission, as well
035 * as an optional short description of this permission. Does not
036 * include any information about any possible permission assignments.
037 * </p><p>
038 * For a complete description of the TS3 permission system, refer to
039 * <a href="http://forum.teamspeak.com/threads/49581-The-New-Permission-Documentataions">
040 * this post</a> on the TeamSpeak forums.
041 * </p>
042 */
043public class PermissionInfo extends Wrapper {
044
045        public PermissionInfo(Map<String, String> map) {
046                super(map);
047        }
048
049        /**
050         * Gets the numerical ID of this permission.
051         * <p>
052         * In most cases, the name of the permission should be
053         * preferred over the numerical ID.
054         * </p>
055         *
056         * @return this permission's numerical ID
057         */
058        public int getId() {
059                return getInt("permid");
060        }
061
062        /**
063         * Gets the name of this permission.
064         * <p>
065         * Boolean permissions are prefixed with {@code b_}<br>
066         * Integer permissions are prefixed with {@code i_}
067         * </p>
068         *
069         * @return this permission's name
070         */
071        public String getName() {
072                return get("permname");
073        }
074
075        /**
076         * A short description about what this permission does.
077         * <p>
078         * Does not exist for all permissions. In that case, an
079         * empty String will be returned instead.
080         * </p>
081         *
082         * @return a short description of this permission
083         */
084        public String getDescription() {
085                return get("permdesc");
086        }
087
088}