com.mobius.software.telco.protocols.diameter.primitives.pc4a.UPRFlags 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.6	UPR-Flags	
	The UPR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in table 6.3.6-1:
	Table 6.3.6-1: UPR-Flags

	Bit Name
	Description

	0 Update
	This bit, when set, indicates that the ProSe subscriber related data are updated.

	1 Removal
	This bit, when set, indicates that all of the ProSe subscriber related data are removed.

	2 Reset-ID Update
	This bit, when set, indicates that the complete list on Reset-IDs is updated.

	3 Reset-ID Removal
	This bit, when set, indicates that the complete list on Reset-IDs is removed.

	NOTE:	Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving ProSe Function.
 */
@DiameterAvpDefinition(code = TgppAvpCodes.UPR_FLAGS, vendorId = VendorIDs.TGPP_ID, name = "UPR-Flags")
public interface UPRFlags extends DiameterBitmask32
{
	public static final int UPDATE_BIT = 0;	
	public static final int REMOVAL_BIT = 1;	
	public static final int RESET_ID_UPDATE_BIT = 2;	
	public static final int RESET_ID_REMOVAL_BIT = 3;	
	
	public void setUpdateBit(boolean isOn);
	
	public boolean isUpdateBitSet();	
	
	public void setRemovalBit(boolean isOn);
	
	public boolean isRemovalBitSet();	
	
	public void setResetIDUpdateBit(boolean isOn);
	
	public boolean isResetIDUpdateBitSet();
	
	public void setResetIDRemovalBit(boolean isOn);
	
	public boolean isResetIDRemovalBitSet();
}