com.mobius.software.telco.protocols.diameter.commands.gy.CreditControlRequest 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.commands.gy;
/*
 * 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 java.util.Date;
import java.util.List;

import com.mobius.software.telco.protocols.diameter.ApplicationIDs;
import com.mobius.software.telco.protocols.diameter.CommandCodes;
import com.mobius.software.telco.protocols.diameter.annotations.DiameterCommandDefinition;
import com.mobius.software.telco.protocols.diameter.exceptions.MissingAvpException;
import com.mobius.software.telco.protocols.diameter.primitives.gy.ServiceInformation;
import com.mobius.software.telco.protocols.diameter.primitives.common.TerminationCauseEnum;
import com.mobius.software.telco.protocols.diameter.primitives.creditcontrol.MultipleServicesIndicatorEnum;
import com.mobius.software.telco.protocols.diameter.primitives.creditcontrol.SubscriptionId;
import com.mobius.software.telco.protocols.diameter.primitives.creditcontrol.UserEquipmentInfo;
import com.mobius.software.telco.protocols.diameter.primitives.gy.TGPPMultipleServicesCreditControl;

/*

			Gy-Credit-Control-Request message
		This section describes the Diameter Gy CCA message format as defined in RFC 4006.
		 ::=  < Diameter Header: 272, PXY >
		     < Session-Id > 
		     { Result-Code }
		     { Origin-Host } 
		     { Origin-Realm } 
		     { Destination-Realm }
		     { Auth-Application-Id } 
		     { Service-Context-Id }
		     { CC-Request-Type } 
		     { CC-Request-Number }
		     [ Destination-Host ] 
		     [ User-Name ] 
		     [ Origin-State-Id ] 
		     [ Event-Timestamp ]
		    *[ Subscription-Id ]
		     [ Termination-Cause ] 
		     [ Multiple-Services-Indicator ]
		    *[ Multiple-Services-Credit-Control ]    
		     [ User-Equipment-Info ] 
		    *[ Route-Record ]
			 [ Service-Information ]
		    *[ AVP ]                  
*/
@DiameterCommandDefinition(applicationId = ApplicationIDs.CREDIT_CONTROL, commandCode = CommandCodes.CREDIT_CONTROL, request = true, proxyable = true, name="Credit-Control-Request")
public interface CreditControlRequest extends com.mobius.software.telco.protocols.diameter.commands.commons.CreditControlRequest
{
	public String getServiceContextId();
	
	void setServiceContextId(String value) throws MissingAvpException;
		
	public Date getEventTimestamp();
	
	void setEventTimestamp(Date value);
	
	public List getSubscriptionId();
	
	void setSubscriptionId(List value);

	public TerminationCauseEnum getTerminationCause();
	
	void setTerminationCause(TerminationCauseEnum value);
	
	public MultipleServicesIndicatorEnum getMultipleServicesIndicator();
	
	void setMultipleServicesIndicator(MultipleServicesIndicatorEnum value);
	
	public List getTGPPMultipleServicesCreditControl();

	void setTGPPMultipleServicesCreditControl(List value);
	
	public UserEquipmentInfo getUserEquipmentInfo();
	
	void setUserEquipmentInfo(UserEquipmentInfo value);

	ServiceInformation getServiceInformation();
	
	void setServiceInformation(ServiceInformation value);

}