net.java.slee.resource.diameter.ro.events.avp
Interface LcsInformation

All Superinterfaces:
java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp
All Known Implementing Classes:
LcsInformationImpl

public interface LcsInformation
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

Defines an interface representing the LCS-Information grouped AVP type.

From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V7.1.0) specification:

 7.2.48 LCS-Information AVP 
 The LCS-Information AVP (AVP code 878) is of type Grouped. Its purpose is to allow the transmission of additional 
 LCS service specific information elements.
 
 It has the following ABNF grammar:
  LCS-Information ::= AVP Header: 878 
      [ LCS-Client-ID ] 
      [ Location-Type ] 
      [ Location-Estimate ] 
      [ Positioning-Data ] #exclude
      [ IMSI ] #exclude 
      [ MSISDN ] #exclude
 

Author:
Alexandre Mendonca , Bartosz Baranowski

Field Summary
 
Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
 
Method Summary
 LcsClientId getLcsClientId()
          Returns the value of the LCS-Client-ID AVP, of type Grouped.
 java.lang.String getLocationEstimate()
          Returns the value of the Location-Estimate AVP, of type UTF8String.
 LocationType getLocationType()
          Returns the value of the Location-Type AVP, of type Grouped.
 boolean hasLcsClientId()
          Returns true if the LCS-Client-ID AVP is present in the message.
 boolean hasLocationEstimate()
          Returns true if the Location-Estimate AVP is present in the message.
 boolean hasLocationType()
          Returns true if the Location-Type AVP is present in the message.
 void setLcsClientId(LcsClientId lcsClientId)
          Sets the value of the LCS-Client-ID AVP, of type Grouped.
 void setLocationEstimate(java.lang.String locationEstimate)
          Sets the value of the Location-Estimate AVP, of type UTF8String.
 void setLocationType(LocationType locationType)
          Sets the value of the Location-Type AVP, of type Grouped.
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp
getExtensionAvps, setExtensionAvps
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, octetStringValue, stringValue
 

Method Detail

getLcsClientId

LcsClientId getLcsClientId()
Returns the value of the LCS-Client-ID AVP, of type Grouped. A return value of null implies that the AVP has not been set.


getLocationEstimate

java.lang.String getLocationEstimate()
Returns the value of the Location-Estimate AVP, of type UTF8String. A return value of null implies that the AVP has not been set.


getLocationType

LocationType getLocationType()
Returns the value of the Location-Type AVP, of type Grouped. A return value of null implies that the AVP has not been set.


hasLcsClientId

boolean hasLcsClientId()
Returns true if the LCS-Client-ID AVP is present in the message.


hasLocationEstimate

boolean hasLocationEstimate()
Returns true if the Location-Estimate AVP is present in the message.


hasLocationType

boolean hasLocationType()
Returns true if the Location-Type AVP is present in the message.


setLcsClientId

void setLcsClientId(LcsClientId lcsClientId)
Sets the value of the LCS-Client-ID AVP, of type Grouped.


setLocationEstimate

void setLocationEstimate(java.lang.String locationEstimate)
Sets the value of the Location-Estimate AVP, of type UTF8String.


setLocationType

void setLocationType(LocationType locationType)
Sets the value of the Location-Type AVP, of type Grouped.



Copyright © 2011. All Rights Reserved.