LibSip_XMLTypes.ttcn

/*
 *	@author 	STF 366
 *  @version    $Id$
 *	@desc		This module provides the XML type system for SIP tests.
 *				The types have been generated automatically, followed by manual modifications:
 *				- bitType substituted by OneBitType
 *				- twobitType substituted by TwoBitType
 *				- addition of pattern for: OneBitType, TwoBitType, ThreeBitType, FourBitType, FourBitType, SixBitType
 *				- application of enumerated for: State_type, Endpoint_status_type, Joining_type, Disconnection_type, Media_status_type, 
 *					Originating_identity_presentation_restriction, Terminating_identity_presentation_restriction
 *				- addition of length value: NetworkIdentityType, SixteenbitType
 *				- addition of value restriction: CugIndexType
 *				- substitution of "content" by "choice": Call_type, Mcid
 *				- additional type renaming (upper first letter): AbsService, Anonymous, Busy, 
 *					Communication_diverted, Conference_description_type, Conference_info,
 *					Conference_media_type, Conference_medium_type, Conference_state_type,
 *					Conference_type, Cug, CugRequestType, Empty_element_type, Endpoint_type,
 *					Execution_type, Host_type, Keywords_type, Media, Media_type, No_answer,
 *					Not_reachable, Not_registered, Originating_identity_presentation, Presence_status,
 *					Presence_status_activity_type, RequestType, ResponseType, Roaming,
 *					Rule_deactivated, Sidebars_by_val_type, Simservs, SimservType,
 *					Terminating_identity_presentation, Uri_type, Uris_type, User_roles_type,
 *   				User_languages_type, User_type, Users_type
 *   
 *   			new group CDIV added by STF369
 */

module LibSip_XMLTypes
{

import from XSDAUX all;

group XmlTypes {

	type union XmlBody{
		Conference_info conferenceInfo,	// if there is XML Conference_info
		Cug cug,						// if there is XML Cug
		Mcid mcid,						// if there is XML Mcid
		PSTN_transit pstnTransit,		// if there is XML PSTN data
		Simservs simservs,				// if there is XML simservs (Oip/r Tip/r ...) 
		Comm_div_info cdivn				// if there is XML CDIVN document
	};

}

group GeneralTypes {
	type Empty_element_type Not_registered;

	type record SimservType {
		XSDAUX.booleanXSD active optional, XSDAUX.anyAttributes anyAttributes
	}

	type Empty_element_type Not_reachable;

	type Empty_element_type Busy;

	type SimservType AbsService;

	type Empty_element_type Communication_diverted;

	type Presence_status_activity_type Presence_status;

	type record Simservs {
		XSDAUX.anyAttributes anyAttributes,
		AbsService absService optional,
		record{
			record of anytype any_1 optional
		} extensions optional
	}

	type Empty_element_type Anonymous;

	type Empty_element_type Rule_deactivated;

	type Empty_element_type No_answer;

	type record Empty_element_type {
	}

	type Empty_element_type Roaming;

	type Media_type Media;

	type XSDAUX.string Presence_status_activity_type;
} /* end group GeneralTypes */

group PSTNTypes {
  type record PSTN_transit {
    record length (1 .. 2) of BearerCapabilityType BearerInfomationElement,
    record length (0 .. 2) of HighLayerCompatibilityType HighLayerCompatibility optional,
    LowLayerCompatibilityType LowLayerCompatibility optional,
    record of ProgressIndicatorType ProgressIndicator optional,
    record of DisplayType Display optional
  }
  
  group BearerCapabilityTypes{

	type record BearerCapabilityType {
    	BCOctet3Type BCoctet3,
    	BCOctet4Type BCoctet4,
    	BCOctet4_1Type BCoctet4_1 optional,
    	BCOctet5Type BCoctet5 optional,
    	BCOctet5aType BCoctet5a optional,
    	BCOctet5bV110Type BCoctet5bV110 optional,
    	BCOctet5bV120Type BCoctet5bV120 optional,
    	BCOctet5cType BCoctet5c optional,
    	BCOctet5dType BCoctet5d optional,
    	BCOctet6Type BCoctet6 optional,
    	BCOctet7Type BCoctet7 optional,
    	BCOctet7aType BCoctet7a optional,
    	BCOctet7bType BCoctet7b optional
	}

	type record BCOctet3Type {
		TwoBitType CodingStandard,
		FiveBitType InformationTransferCapability
	}

	type record BCOctet4Type {
		TwoBitType TransferMode,
		FiveBitType InformationTransferRate
	}

	type record BCOctet4_1Type {
		SevenBitType RateMultiplier
	}

	type record BCOctet5Type {
		TwoBitType Layer1Identification,
		FiveBitType UserInfoLayer1Protocol
	}

	type record BCOctet5aType {
		OneBitType SynchronousAsynchronous,
		OneBitType Negotiation,
		FiveBitType UserRate
	}

	type record BCOctet5bV110Type {
		TwoBitType IntermediateRate,
		OneBitType NIConTX,
		OneBitType NIConRX,
		OneBitType FlowControlOnTX,
		OneBitType FlowControlOnRX
	}

	type record BCOctet5bV120Type {
		OneBitType RateAdaptionHeader,
		OneBitType MultipleFrameEstablishmentSupport,
		OneBitType ModeOfOperation,
		OneBitType LogicalLinkIdentifier,
		OneBitType Assignor,
		OneBitType InbandOutbandNegotiation
	}

	type record BCOctet5cType {
		TwoBitType NumberOfStopBits,
		TwoBitType NumberOfDataBits,
		ThreeBitType Parity
	}

	type record BCOctet5dType {
		OneBitType DuplexMode,
		SixBitType ModemType
	}

	type record BCOctet6Type {
		TwoBitType Layer2Identification,
		FiveBitType UserInfoLayer2Protocol
	}

	type record BCOctet7Type {
		TwoBitType Layer3Identification,
		FiveBitType UserInfoLayer3Protocol
	}

	type record BCOctet7aType {
		FourBitType AdditionalLayer3Info
	}

	type record BCOctet7bType {
		FourBitType AdditionalLayer3Info
	}
  
  } //end group BearerCapabilityTypes
  
  group HighLayerCompatibilityTypes{ 

	type record HighLayerCompatibilityType {
		HLOctet3Type HLOctet3,
		HLOctet4Type HLOctet4,
		HLOctet4aMaintenanceType HLOctet4aMaintenance optional,
		HLOctet4aAudioType HLOctet4Audio optional
	}

	type record HLOctet3Type {
		TwoBitType CodingStandard,
		ThreeBitType Interpretation,
		TwoBitType PresentationMethod
	}

	type record HLOctet4Type {
		SevenBitType HighLayerCharacteristics
	}

	type record HLOctet4aMaintenanceType {
		SevenBitType HighLayerCharacteristics
	}

	type record HLOctet4aAudioType {
		SevenBitType VideoTelephonyCharacteristics
	}
  
  } //end group HighLayerCompatibilityTypes
  
  group LowLayerCompatibilityTypes{

	type record LowLayerCompatibilityType {
		LLOctet3Type LLOctet3,
		LLOctet3aType LLOctet3a optional,
		LLOctet4Type LLOctet4,
		LLOctet4_1Type LLOctet4_1 optional,
		LLOctet5Type LLOctet5 optional,
		LLOctet5aType LLOctet5a optional,
		LLOctet5bV110Type LLOctet5bV110 optional,
		LLOctet5bV120Type LLOctet5bV120 optional,
		LLOctet5cType LLOctet5c optional,
		LLOctet5dType LLOctet5d optional,
		LLOctet6Type LLOctet6 optional,
		LLOctet6aHDLCType LLOctet6aHDLC optional,
		LLOctet6aUserSpecificType LLOctet6aUserSpecific optional,
		LLOctet6bType LLOctet6b optional,
		LLOctet7Type LLOctet7 optional, //corrected due to ISUP TTCN3 solution
		LLOctet7aUserSpecificType LLOctet7aUserSpecific optional,
		LLOctet7aX25Type LLOctet7aX25 optional,
		LLOctet7bX25Type LLOctet7bX25 optional,
		LLOctet7cType LLOctet7c optional,
		LLOctet7aTR9577Type LLOctet7aTR9577 optional,
		LLOctet7bTR9577Type LLOctet7bTR9577 optional
	} 

	type record LLOctet3Type {
		TwoBitType CodingStandard,
		FiveBitType InformationTransferCapability
	}

	type record LLOctet3aType {
		OneBitType NegotiationIndicator
	} 

	type record LLOctet4Type {
		TwoBitType TransferMode,
		FiveBitType InformationTransferRate
	}

	type record LLOctet4_1Type {
		SevenBitType RateMultiplier
	}

	type record LLOctet5Type {
		TwoBitType Layer1Identification,
		FiveBitType UserInfoLayer1Protocol
	}

	type record LLOctet5aType {
		OneBitType SynchronousAsynchronous,
		OneBitType Negotiation,
		FiveBitType UserRate
	}

	type record LLOctet5bV110Type {
		TwoBitType IntermediateRate,
		OneBitType NIConTX,
		OneBitType NIConRX,
		OneBitType FlowControlOnTX,
		OneBitType FlowControlOnRX
	}

	type record LLOctet5bV120Type {
		OneBitType RateAdaptionHeader,
		OneBitType MultipleFrameEstablishmentSupport,
		OneBitType ModeOfOperation,
		OneBitType LogicalLinkIdentifier,
		OneBitType Assignor,
		OneBitType InbandOutbandNegotiation
	}

	type record LLOctet5cType {
		TwoBitType NumberOfStopBits,
		TwoBitType NumberOfDataBits,
		ThreeBitType Parity
	}

	type record LLOctet5dType {
		OneBitType DuplexMode,
		SixBitType ModemType
	}

	type record LLOctet6Type {
		TwoBitType Layer2Identification,
		FiveBitType UserInfoLayer2Protocol
	}

	type record LLOctet6aHDLCType {
		TwoBitType Mode
	}

	type record LLOctet6aUserSpecificType {
		SevenBitType UserSpecificLayer2Information
	}

	type record LLOctet6bType {
		SevenBitType WindowSize
	}

	type record LLOctet7Type {
		TwoBitType Layer3Identification,
		FiveBitType UserInfoLayer3Protocol
	}

	type record LLOctet7aTR9577Type {
		FourBitType AdditionalLayer3Info
	}

	type record LLOctet7aUserSpecificType {
		SevenBitType OptionalLayer3Information
	}

	type record LLOctet7aX25Type {
		TwoBitType Mode
	}

	type record LLOctet7bTR9577Type {
		FourBitType AdditionalLayer3Info
	}

	type record LLOctet7bX25Type {
		FourBitType DefaultPacketSize
	}

	type record LLOctet7cType {
		SevenBitType PacketWindowSize
	}
  
  } //end group LowLayerCompatibilityTypes
  
  group ProgressIndicatorTypes{

	type record ProgressIndicatorType {
		ProgressOctet3Type ProgressOctet3,
		ProgressOctet4Type ProgressOctet4
	} 

	type record ProgressOctet3Type {
			TwoBitType CodingStandard,
			FourBitType Location
	}

	type record ProgressOctet4Type {
			SevenBitType ProgressDescription
	}
  
  } //end group ProgressIndicatorTypes
  
  group DisplayTypes{

	type record DisplayType {
		DispOctet3Type DispOctet3
	}

	type record DispOctet3Type {
		SevenBitType DisplayInformation
	}
	
  } //end group DisplayTypes

  group BitTypes{
  	
	type XSDAUX.string OneBitType (pattern "(0|1)"); 

	type XSDAUX.string TwoBitType (pattern "(0|1)(0|1)"); 

	type XSDAUX.string ThreeBitType (pattern "(0|1)(0|1)(0|1)");

	type XSDAUX.string FourBitType (pattern "(0|1)(0|1)(0|1)(0|1)"); 

	type XSDAUX.string FiveBitType (pattern "(0|1)(0|1)(0|1)(0|1)(0|1)");

	type XSDAUX.string SixBitType (pattern "(0|1)(0|1)(0|1)(0|1)(0|1)(0|1)");
  
	type XSDAUX.string SevenBitType (pattern "(0|1)(0|1)(0|1)(0|1)(0|1)(0|1)(0|1)");
  } //end group BitTypes
}
with {
  encode "PSTN";
}/* end group PSTNTypes */

group CONFTypes {

  type Conference_type Conference_info; 

  type record Conference_type {
	XSDAUX.anyURI entity,
	State_type state optional,
	XSDAUX.unsignedInt version optional,
	XSDAUX.anyAttributes anyAttributes,
	Conference_description_type conference_description optional,
	Host_type host_info optional,
	Conference_state_type conference_state optional,
	Users_type users optional,
	Uris_type sidebars_by_ref optional,
	Sidebars_by_val_type sidebars_by_val optional,
	record of anytype any_1 optional
  }
	
  type record Media_type {
    XSDAUX.string id,
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string display_text optional,
    XSDAUX.string type_ optional,
    XSDAUX.string label_ optional,
    XSDAUX.string src_id optional,
    Media_status_type status optional,
    record of anytype any_1 optional
  }

  type record Endpoint_type {
    XSDAUX.string entity optional,
    State_type state optional,
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string display_text optional,
    Execution_type referred optional,
    Endpoint_status_type status optional,
    Joining_type joining_method optional,
    Execution_type joining_info optional,
    Disconnection_type disconnection_method optional,
    Execution_type disconnection_info optional,
    record of Media_type media optional,
    Call_type call_info optional,
    record of anytype any_1 optional
  }

  type record Uri_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.anyURI uri,
    XSDAUX.string display_text optional,
    XSDAUX.string purpose optional,
    Execution_type modified optional,
    record of anytype any_1 optional
  }

  type record of XSDAUX.string Keywords_type; 

  type record Conference_state_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.unsignedInt user_count optional,
    XSDAUX.booleanXSD active optional,
    XSDAUX.booleanXSD locked optional,
    record of anytype any_1 optional
  }

  type record Execution_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.dateTime when optional,
    XSDAUX.string reason optional,
    XSDAUX.anyURI by optional
  }

  type record Host_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string display_text optional,
    XSDAUX.anyURI web_page optional,
    Uris_type uris optional,
    record of anytype any_1 optional
  }

  type record Sip_dialog_id_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string display_text optional,
    XSDAUX.string call_id,
    XSDAUX.string from_tag,
    XSDAUX.string to_tag,
    record of anytype any_1 optional
  }

  type record Conference_description_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string display_text optional,
    XSDAUX.string subject optional,
    XSDAUX.string free_text optional,
    Keywords_type keywords optional,
    Uris_type conf_uris optional,
    Uris_type service_uris optional,
    XSDAUX.unsignedInt maximum_user_count optional,
    Conference_media_type available_media optional,
    record of anytype any_1 optional
  }

  type record of XSDAUX.languageXSD User_languages_type; 

  type record User_roles_type {
    XSDAUX.anyAttributes anyAttributes,
    record length (1 .. infinity) of XSDAUX.string entry
  }

//  type XSDAUX.string joining_type;
  type enumerated Joining_type {dialed_in, dialed_out, focus_owner};

//  type XSDAUX.string disconnection_type; 
  type enumerated Disconnection_type {departed, booted, failed, busy};

  type record Sidebars_by_val_type {
    State_type state optional,
    XSDAUX.anyAttributes anyAttributes,
    record of Conference_type entry optional
  }

  type record User_type {
    XSDAUX.anyURI entity optional,
    State_type state optional,
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string display_text optional,
    Uris_type associated_aors optional,
    User_roles_type roles optional,
    User_languages_type languages optional,
    XSDAUX.anyURI cascaded_focus optional,
    record of Endpoint_type endpoint optional,
    record of anytype any_1 optional
  }

//  type XSDAUX.string media_status_type; 
  type enumerated Media_status_type {recvonly, sendonly, sendrecv, inactive};

//  type XSDAUX.string endpoint_status_type; 
  type enumerated Endpoint_status_type 
  	{pending, dialing_out, dialing_in, alerting, on_hold,connected,
  		muted_via_focus, disconnecting, disconnected};

  type record Conference_medium_type {
    XSDAUX.string label_,
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string display_text optional,
    XSDAUX.string type_,
    Media_status_type status optional,
    record of anytype any_1 optional
  }

  type record Users_type {
    State_type state optional,
    XSDAUX.anyAttributes anyAttributes,
    record of User_type user optional,
    record of anytype any_1 optional
  }

  type record Uris_type {
    State_type state optional,
    XSDAUX.anyAttributes anyAttributes,
    record length (1 .. infinity) of Uri_type entry
  }

  type record Call_type {
    XSDAUX.anyAttributes anyAttributes,
    union {
      Sip_dialog_id_type sip,
      record length (0 .. 1) of record of anytype any_1
    } choice
  }

//  type XSDAUX.string state_type; 
  type enumerated State_type {full, partial, deleted};

  type record Conference_media_type {
    XSDAUX.anyAttributes anyAttributes,
    record length (1 .. infinity) of Conference_medium_type entry
  }
}
with {
  encode "CONF";
} /* end group CONFTypes */ 
 
group CUGTypes{
	type XSDAUX.integerXSD CugIndexType (0 .. 32767);

	type record CugRequestType {
		XSDAUX.booleanXSD outgoingAccessRequest optional, //optional [Ref: ETSI TS 124 454 V8.0.0 Table 4.5.2.4.1:]
		CugIndexType cugIndex optional //optional [Ref: ETSI TS 124 454 V8.0.0 Table 4.5.2.4.1:]
	}

	type XSDAUX.hexBinary SixteenbitType length(2);

	type record Cug {
		CugRequestType cugCallOperation optional,
		NetworkIdentityType networkIndicator optional,
		SixteenbitType cugInterlockBinaryCode optional,
		TwoBitType cugCommunicationIndicator optional
	}

//	type XSDAUX.string twobitType;

	type XSDAUX.hexBinary NetworkIdentityType length(1);
}
with {
  encode "CUG";
} /* end group CUGTypes */

group MCIDTypes{
//  type XSDAUX.string bitType; 

  type record ResponseType {
    OneBitType McidResponseIndicator,
	OneBitType HoldingProvidedIndicator
  }

  type record RequestType {
	OneBitType McidRequestIndicator,
	OneBitType HoldingIndicator
  }

  type record Mcid {
    union {
      RequestType request,
      ResponseType response
    } choice
  }
}
with {
  encode "MCID";
} /* end group MCIDTypes */

group OIP_R_Types{
	type record Originating_identity_presentation_restriction {
		XSDAUX.booleanXSD active optional,
		XSDAUX.anyAttributes anyAttributes,
		enumerated {presentation_restricted, presentation_not_restricted} default_behaviour optional
	}

	type SimservType Originating_identity_presentation;
} /* end group OIP_R_Types */

group TIP_R_Types{
	type SimservType Terminating_identity_presentation;

	type record Terminating_identity_presentation_restriction {
		XSDAUX.booleanXSD active optional,
		XSDAUX.anyAttributes anyAttributes,
		enumerated {presentation_restricted, presentation_not_restricted} default_behaviour optional
	}
} /* end group TIP_R_Types */

group CDIV{

/*
	*	@desc		This module provides the XML type system for communication diversion. (ETSI TS 124504, V8.4.0)
	*				The types have been generated automatically, followed by manual modifications (STF369):
	*				- application of enumerated for: Diversion_reason_info_type
	*				- addition of value restriction: Comm_div_ntfy_trigger_criteria_type
	*				- additional type renaming (upper first letter): all types in group			
	*/

  type record Comm_div_ntfy_trigger_criteria_type {
    XSDAUX.anyAttributes anyAttributes,
    Time_range_selection_criteria_type notification_time_selection_criteria optional,
    Presence_status_selection_criteria_type presence_status_selection_criteria optional,
    XSDAUX.integerXSD notification_buffer_interval (-infinity .. 86400) optional,
    record of anytype any_1 optional
  }

  type record Comm_div_info_type {
    XSDAUX.anyURI entity,
    Comm_div_subs_info_type comm_div_subs_info optional,
    Comm_div_ntfy_info_type comm_div_ntfy_info optional,
    record of anytype any_1 optional
  }

  type record Comm_div_selection_criteria_type {
    XSDAUX.anyAttributes anyAttributes,
    User_selection_criteria_type originating_user_selection_criteria optional,
    XSDAUX.anyURI diverting_user_selection_criteria optional,
    XSDAUX.anyURI diverted_to_user_selection_criteria optional,
    Time_range_selection_criteria_type diversion_time_selection_criteria optional,
    Diversion_reason_selection_criteria_type diversion_reason_selection_criteria optional,
    record of anytype any_1 optional
  }

  type record User_selection_criteria_type {
    XSDAUX.anyAttributes anyAttributes,
    record of User_info_type user_info optional
  }

  type record Comm_div_info_selection_criteria_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.booleanXSD disable_originating_user_info optional,
    XSDAUX.booleanXSD disable_diverting_user_info optional,
    XSDAUX.booleanXSD disable_diverted_to_user_info optional,
    XSDAUX.booleanXSD disable_diversion_time_info optional,
    XSDAUX.booleanXSD disable_diversion_reason_info optional,
    XSDAUX.booleanXSD disable_diversion_rule_info optional,
    record of anytype any_1 optional
  }

  type record Time_range_selection_criteria_type {
    XSDAUX.anyAttributes anyAttributes,
    record of Time_range_type time_range optional
  }

  type record Comm_div_subs_info_type {
    XSDAUX.anyAttributes anyAttributes,
    Comm_div_selection_criteria_type comm_div_selection_criteria optional,
    Comm_div_ntfy_trigger_criteria_type comm_div_ntfy_trigger_criteria optional,
    Comm_div_info_selection_criteria_type comm_div_info_selection_criteria optional,
    record of anytype any_1 optional
  }

  type Comm_div_info_type Comm_div_info; 

  type record of Diversion_reason_info_type Diversion_reason_info_types; 

  type record Time_range_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.dateTime start_time,
    XSDAUX.dateTime end_time
  }

  type record Diversion_reason_selection_criteria_type {
    XSDAUX.anyAttributes anyAttributes,
    Diversion_reason_info_types diversion_reason_info
  }

  type record User_info_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string user_name optional,
    XSDAUX.anyURI user_URI
  }

  type record Diversion_rule_info_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string diversion_rule
  }

  type record Presence_status_info_type {
    XSDAUX.anyAttributes anyAttributes,
    XSDAUX.string presence_status
  }

  type enumerated Diversion_reason_info_type {int404(404),int486(486),int408(408),int302(302),int487(487),int480(480),int503(503)}; 

  type record Comm_div_ntfy_info_type {
    XSDAUX.anyAttributes anyAttributes,
    User_info_type originating_user_info optional,
    XSDAUX.anyURI diverting_user_info optional,
    XSDAUX.anyURI diverted_to_user_info optional,
    XSDAUX.dateTime diversion_time_info optional,
    Diversion_reason_info_type diversion_reason_info optional,
    Diversion_rule_info_type diversion_rule_info optional,
    record of anytype any_1 optional
  }

  type record Presence_status_selection_criteria_type {
    XSDAUX.anyAttributes anyAttributes,
    record of Presence_status_info_type presence_status_info optional
  }

} /* end group CDIV */

} /* end module SipIsup_SIP_XMLTypes */