com.mobius.software.telco.protocols.diameter.primitives.pc4a.ProSeDirectAllowed Maven / Gradle / Ivy

Go to download
package com.mobius.software.telco.protocols.diameter.primitives.pc4a;
/*
 * Mobius Software LTD
 * Copyright 2023, Mobius Software LTD and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 */

import com.mobius.software.telco.protocols.diameter.TgppAvpCodes;
import com.mobius.software.telco.protocols.diameter.VendorIDs;
import com.mobius.software.telco.protocols.diameter.annotations.DiameterAvpDefinition;
import com.mobius.software.telco.protocols.diameter.primitives.DiameterBitmask32;

/**
*
* @author yulian oifa
*
*/

/*
	6.3.5	ProSe-Direct-Allowed
	The ProSe-Direct-Allowed AVP is of type Unsigned32 and it shall contain a bit mask that indicates the services the UE is authorised to use for ProSe Direct functionalities in a specific PLMN. The meaning of the bits shall be as defined in table 6.3.5-1:
	Table 6.3.5-1: ProSe-Direct-Allowed 

	Bit Name
	Description

	0 Announce
	This bit, when set, indicates that the user is allowed to announce in the corresponding PLMN for open ProSe Discovery.

	1 Monitor
	This bit, when set, indicates that the user is allowed to monitor in the corresponding PLMN for open ProSe Discovery.

	2 Communication
	This bit, when set, indicates that the user is allowed for ProSe direct one to many communication in the corresponding PLMN.

	3 One-to-one Communication
	This bit, when set, indicates that the user is allowed to perform one-to-one ProSe Direct Communication.

	4 Discoverer
	This bit, when set, indicates that the user is allowed to perform discoverer operation in the corresponding PLMN for ProSe Discovery Model B.

	5 Discoveree
	This bit, when set, indicates that the user is allowed to perform discoveree operation in the corresponding PLMN for ProSe Discovery Model B.

	6 Restricted-announce
	This bit, when set, indicates that the user is allowed to announce in the corresponding PLMN for restricted ProSe Discovery.

	7 Restricted-monitoring
	This bit, when set, indicates that the user is allowed to monitor in the corresponding PLMN for restricted ProSe Discovery.

	8 Application-controlled extension
	This bit, when set, indicates that the user is allowed to announce or monitor with application-controlled extension in the corresponding PLMN for restricted ProSe Discovery

	9 On-demand announcing
	This bit, when set, indicates that the user is allowed to perform on-demand announcing in the corresponding PLMN for restricted ProSe Discovery

	NOTE:	Bits not defined in this table shall be cleared by the HSS and discarded by the receiving ProSe Function.
 */
@DiameterAvpDefinition(code = TgppAvpCodes.PROSE_DIRECT_ALLOWED, vendorId = VendorIDs.TGPP_ID, name = "ProSe-Direct-Allowed")
public interface ProSeDirectAllowed extends DiameterBitmask32
{
	public static final int ANNOUNCE_BIT = 0;	
	public static final int MONITOR_BIT = 1;	
	public static final int COMMUNICATION_BIT = 2;	
	public static final int ONE_TO_ONE_COMMUNICATION_BIT = 3;	
	public static final int DISCOVERER_BIT = 4;	
	public static final int DISCOVEREE_BIT = 5;	
	public static final int RESTRICTED_ANNOUNCE_BIT = 6;	
	public static final int RESTRICTED_MONITORING_BIT = 7;	
	public static final int APPLICATION_CONTROLLED_EXTENSION_BIT = 8;	
	public static final int ON_DEMAND_ANNOUNCING_BIT = 9;	
	
	public void setAnnounceBit(boolean isOn);
	
	public boolean isAnnounceBitSet();	
	
	public void setMonitorBit(boolean isOn);
	
	public boolean isMonitorBitSet();	
	
	public void setCommunicationBit(boolean isOn);
	
	public boolean isCommunicationBitSet();
	
	public void setOneToOneCommunicationBit(boolean isOn);
	
	public boolean isOneToOneCommunicationBitSet();
	
	public void setDiscovererBit(boolean isOn);
	
	public boolean isDiscovererBitSet();	
	
	public void setDiscovereeBit(boolean isOn);
	
	public boolean isDiscovereeBitSet();	
	
	public void setRestrictedAnnounceBit(boolean isOn);
	
	public boolean isRestrictedAnnounceBitSet();
	
	public void setRestrictedMonitoringBit(boolean isOn);
	
	public boolean isRestrictedMonitoringBitSet();
	
	public void setApplicationControlledExtensionBit(boolean isOn);
	
	public boolean isApplicationControlledExtensionBitSet();
	
	public void setOnDemandAnnouncingBit(boolean isOn);
	
	public boolean isOnDemandAnnouncingBitSet();
}