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

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:
LcsClientIdImpl

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

Defines an interface representing the LCS-Client-ID grouped AVP type.

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

 7.2.43 LCS-Client-ID AVP 
 The LCS-Client-Id AVP (AVP code 1232) is of type Grouped and holds information related to the identity of an LCS
 client. 
 
 It has the following ABNF grammar: 
  LCS-Client-ID ::= AVP Header: 1232 
      [ LCS-Client-Type ] 
      [ LCS-Client-External-ID ] 
      [ LCS-Client-Dialed-By-MS ] 
      [ LCS-Client-Name ]
      [ LCS-APN ] 
      [ LCS-Requestor-ID ]
 

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
 java.lang.String getLcsApn()
          Returns the value of the LCS-APN AVP, of type UTF8String.
 java.lang.String getLcsClientDialedByMs()
          Returns the value of the LCS-Client-Dialed-By-MS AVP, of type UTF8String.
 java.lang.String getLcsClientExternalId()
          Returns the value of the LCS-Client-External-ID AVP, of type UTF8String.
 LcsClientName getLcsClientName()
          Returns the value of the LCS-Client-Name AVP, of type Grouped.
 LcsClientType getLcsClientType()
          Returns the value of the LCS-Client-Type AVP, of type Enumerated.
 LcsRequestorId getLcsRequestorId()
          Returns the value of the LCS-Requestor-ID AVP, of type Grouped.
 boolean hasLcsApn()
          Returns true if the LCS-APN AVP is present in the message.
 boolean hasLcsClientDialedByMs()
          Returns true if the LCS-Client-Dialed-By-MS AVP is present in the message.
 boolean hasLcsClientExternalId()
          Returns true if the LCS-Client-External-ID AVP is present in the message.
 boolean hasLcsClientName()
          Returns true if the LCS-Client-Name AVP is present in the message.
 boolean hasLcsClientType()
          Returns true if the LCS-Client-Type AVP is present in the message.
 boolean hasLcsRequestorId()
          Returns true if the LCS-Requestor-ID AVP is present in the message.
 void setLcsApn(java.lang.String lcsApn)
          Sets the value of the LCS-APN AVP, of type UTF8String.
 void setLcsClientDialedByMs(java.lang.String lcsClientDialedByMs)
          Sets the value of the LCS-Client-Dialed-By-MS AVP, of type UTF8String.
 void setLcsClientExternalId(java.lang.String lcsClientExternalId)
          Sets the value of the LCS-Client-External-ID AVP, of type UTF8String.
 void setLcsClientName(LcsClientName lcsClientName)
          Sets the value of the LCS-Client-Name AVP, of type Grouped.
 void setLcsClientType(LcsClientType lcsClientType)
          Sets the value of the LCS-Client-Type AVP, of type Enumerated.
 void setLcsRequestorId(LcsRequestorId lcsRequestorId)
          Sets the value of the LCS-Requestor-ID 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

getLcsApn

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


getLcsClientDialedByMs

java.lang.String getLcsClientDialedByMs()
Returns the value of the LCS-Client-Dialed-By-MS AVP, of type UTF8String. A return value of null implies that the AVP has not been set.


getLcsClientExternalId

java.lang.String getLcsClientExternalId()
Returns the value of the LCS-Client-External-ID AVP, of type UTF8String. A return value of null implies that the AVP has not been set.


getLcsClientName

LcsClientName getLcsClientName()
Returns the value of the LCS-Client-Name AVP, of type Grouped. A return value of null implies that the AVP has not been set.


getLcsClientType

LcsClientType getLcsClientType()
Returns the value of the LCS-Client-Type AVP, of type Enumerated. A return value of null implies that the AVP has not been set.


getLcsRequestorId

LcsRequestorId getLcsRequestorId()
Returns the value of the LCS-Requestor-ID AVP, of type Grouped. A return value of null implies that the AVP has not been set.


hasLcsApn

boolean hasLcsApn()
Returns true if the LCS-APN AVP is present in the message.


hasLcsClientDialedByMs

boolean hasLcsClientDialedByMs()
Returns true if the LCS-Client-Dialed-By-MS AVP is present in the message.


hasLcsClientExternalId

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


hasLcsClientName

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


hasLcsClientType

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


hasLcsRequestorId

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


setLcsApn

void setLcsApn(java.lang.String lcsApn)
Sets the value of the LCS-APN AVP, of type UTF8String.


setLcsClientDialedByMs

void setLcsClientDialedByMs(java.lang.String lcsClientDialedByMs)
Sets the value of the LCS-Client-Dialed-By-MS AVP, of type UTF8String.


setLcsClientExternalId

void setLcsClientExternalId(java.lang.String lcsClientExternalId)
Sets the value of the LCS-Client-External-ID AVP, of type UTF8String.


setLcsClientName

void setLcsClientName(LcsClientName lcsClientName)
Sets the value of the LCS-Client-Name AVP, of type Grouped.


setLcsClientType

void setLcsClientType(LcsClientType lcsClientType)
Sets the value of the LCS-Client-Type AVP, of type Enumerated.


setLcsRequestorId

void setLcsRequestorId(LcsRequestorId lcsRequestorId)
Sets the value of the LCS-Requestor-ID AVP, of type Grouped.



Copyright © 2011. All Rights Reserved.