com.mobius.software.telco.protocols.diameter.primitives.rfc5777.DayOfWeekMask Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of diameter-api Show documentation

There is a newer version: 10.0.0-17-java11

package com.mobius.software.telco.protocols.diameter.primitives.rfc5777;
/*
 * 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.AvpCodes;
import com.mobius.software.telco.protocols.diameter.annotations.DiameterAvpDefinition;
import com.mobius.software.telco.protocols.diameter.exceptions.InvalidAvpValueException;
import com.mobius.software.telco.protocols.diameter.primitives.DiameterBitmask32;

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

/*
	4.2.4.  Day-Of-Week-Mask AVP

   	The Day-Of-Week-Mask AVP (AVP Code 563) is of type Unsigned32.  The
   	value is a bit mask that specifies the day of the week for the time
   	window to match.  This document specifies the following bits:
   	
   	Bit  | Name
     ------+------------
       0   | SUNDAY
       1   | MONDAY
       2   | TUESDAY
       3   | WEDNESDAY
       4   | THURSDAY
       5   | FRIDAY
       6   | SATURDAY

   	The bit MUST be set for the time window to match on the corresponding
   	day of the week.  Bit 0 is the least significant bit and unused bits
   	MUST be cleared.  If this AVP is absent from the Time-Of-Day-
   	Condition AVP, the time windows match on all days of the week.
 */
@DiameterAvpDefinition(code = AvpCodes.DAY_OF_WEEK_MASK, vendorId = -1L, name = "Day-Of-Week-Mask")
public interface DayOfWeekMask extends DiameterBitmask32
{
	public static final int SUNDAY = 1;
	public static final int MONDAY = 2;
	public static final int TUESDAY = 3;
	public static final int WEDNESDAY = 4;
	public static final int THURSDAY = 5;
	public static final int FRIDAY = 6;
	public static final int SATURDAY = 7;
	
	public void setDayBit(int dow, boolean isOn) throws InvalidAvpValueException;
	
	public boolean isDayBitSet(int dow) throws InvalidAvpValueException;	
}