public interface PocInformation extends GroupedAvp
7.2.144 PoC-Information AVP The PoC-Information AVP (AVP code 879) is of type Grouped. Its purpose is to allow the transmission of additional PoC service specific information elements. It has the following ABNF grammar: PoC-Information ::= < AVP Header: 879> [ PoC-Server-Role ] [ PoC-Session-Type ] [ PoC-User-Role ] [ PoC-Session-Initiation-Type ] [ PoC-Event-Type ] [ Number-Of-Participants ] * [ Participants-Involved ] * [ Participant-Group ] * [ Talk-Burst-Exchange ] [ PoC-Controlling-Address ] [ PoC-Group-Name ] [ PoC-Session-Id ] [ Charged-Party ] NOTE: In the ABNF definition of PoC-Information AVP, the Participants-Involved AVP is kept only for backward compatibility with Releases before the 3GPP Release 7.Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getChargedParty()
Returns the value of the Charged-Party AVP, of type UTF8String.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getNumberOfParticipants()
Returns the value of the Number-Of-Participants AVP, of type Unsigned32.
|
ParticipantGroup[] |
getParticipantGroups()
Returns the set of Participant-Group AVPs.
|
java.lang.String[] |
getParticipantsInvolveds()
Returns the set of Participants-Involved AVPs.
|
java.lang.String |
getPocControllingAddress()
Returns the value of the PoC-Controlling-Address AVP, of type UTF8String.
|
PocEventType |
getPocEventType()
Returns the value of the PoC-Event-Type AVP, of type Enumerated.
|
java.lang.String |
getPocGroupName()
Returns the value of the PoC-Group-Name AVP, of type UTF8String.
|
PocServerRole |
getPocServerRole()
Returns the value of the PoC-Server-Role AVP, of type Enumerated.
|
java.lang.String |
getPocSessionId()
Returns the value of the PoC-Session-Id AVP, of type UTF8String.
|
PocSessionInitiationType |
getPocSessionInitiationType()
Returns the value of the PoC-Session-Initiation-Type AVP, of type Enumerated.
|
PocSessionType |
getPocSessionType()
Returns the value of the PoC-Session-Type AVP, of type Enumerated.
|
PocUserRole |
getPocUserRole()
Returns the value of the PoC-User-Role AVP, of type Grouped.
|
TalkBurstExchange[] |
getTalkBurstExchanges()
Returns the set of Talk-Burst-Exchange AVPs.
|
boolean |
hasChargedParty()
Returns true if the Charged-Party AVP is present in the PoC-Information AVP.
|
boolean |
hasNumberOfParticipants()
Returns true if the Number-Of-Participants AVP is present in the PoC-Information AVP.
|
boolean |
hasPocControllingAddress()
Returns true if the PoC-Controlling-Address AVP is present in the PoC-Information AVP.
|
boolean |
hasPocEventType()
Returns true if the PoC-Event-Type AVP is present in the PoC-Information AVP.
|
boolean |
hasPocGroupName()
Returns true if the PoC-Group-Name AVP is present in the PoC-Information AVP.
|
boolean |
hasPocServerRole()
Returns true if the PoC-Server-Role AVP is present in the PoC-Information AVP.
|
boolean |
hasPocSessionId()
Returns true if the PoC-Session-Id AVP is present in the PoC-Information AVP.
|
boolean |
hasPocSessionInitiationType()
Returns true if the PoC-Session-Initiation-Type AVP is present in the PoC-Information AVP.
|
boolean |
hasPocSessionType()
Returns true if the PoC-Session-Type AVP is present in the PoC-Information AVP.
|
boolean |
hasPocUserRole()
Returns true if the PoC-User-Role AVP is present in the PoC-Information AVP.
|
void |
removeChargedParty()
Removes the Charged-Party AVP from the PoC-Information AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the PoC-Information AVP.
|
void |
removeNumberOfParticipants()
Removes the Number-Of-Participants AVP from the PoC-Information AVP.
|
void |
removeParticipantGroups()
Removes all Participant-Group AVPs from the PoC-Information AVP.
|
void |
removeParticipantsInvolveds()
Removes all Participants-Involved AVPs from the PoC-Information AVP.
|
void |
removePocControllingAddress()
Removes the PoC-Controlling-Address AVP from the PoC-Information AVP.
|
void |
removePocEventType()
Removes the PoC-Event-Type AVP from the PoC-Information AVP.
|
void |
removePocGroupName()
Removes the PoC-Group-Name AVP from the PoC-Information AVP.
|
void |
removePocServerRole()
Removes the PoC-Server-Role AVP from the PoC-Information AVP.
|
void |
removePocSessionId()
Removes the PoC-Session-Id AVP from the PoC-Information AVP.
|
void |
removePocSessionInitiationType()
Removes the PoC-Session-Initiation-Type AVP from the PoC-Information AVP.
|
void |
removePocSessionType()
Removes the PoC-Session-Type AVP from the PoC-Information AVP.
|
void |
removePocUserRole()
Removes the PoC-User-Role AVP from the PoC-Information AVP.
|
void |
removeTalkBurstExchanges()
Removes all Talk-Burst-Exchange AVPs from the PoC-Information AVP.
|
void |
setChargedParty(java.lang.String chargedParty)
Sets the value of the Charged-Party AVP, of type UTF8String.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setNumberOfParticipants(long numberOfParticipants)
Sets the value of the Number-Of-Participants AVP, of type Unsigned32.
|
void |
setParticipantGroup(ParticipantGroup participantGroup)
Sets a single Participant-Group AVP in the PoC-Information AVP, of type Grouped.
|
void |
setParticipantGroups(ParticipantGroup[] participantGroups)
Sets the set of Participant-Group AVPs, with all the values in the given array.
|
void |
setParticipantsInvolved(java.lang.String participantsInvolved)
Sets a single Participants-Involved AVP in the PoC-Information AVP, of type UTF8String.
|
void |
setParticipantsInvolveds(java.lang.String[] participantsInvolveds)
Sets the set of Participants-Involved AVPs, with all the values in the given array.
|
void |
setPocControllingAddress(java.lang.String pocControllingAddress)
Sets the value of the PoC-Controlling-Address AVP, of type UTF8String.
|
void |
setPocEventType(PocEventType pocEventType)
Sets the value of the PoC-Event-Type AVP, of type Enumerated.
|
void |
setPocGroupName(java.lang.String pocGroupName)
Sets the value of the PoC-Group-Name AVP, of type UTF8String.
|
void |
setPocServerRole(PocServerRole pocServerRole)
Sets the value of the PoC-Server-Role AVP, of type Enumerated.
|
void |
setPocSessionId(java.lang.String pocSessionId)
Sets the value of the PoC-Session-Id AVP, of type UTF8String.
|
void |
setPocSessionInitiationType(PocSessionInitiationType pocSessionInitiationType)
Sets the value of the PoC-Session-Initiation-Type AVP, of type Enumerated.
|
void |
setPocSessionType(PocSessionType pocSessionType)
Sets the value of the PoC-Session-Type AVP, of type Enumerated.
|
void |
setPocUserRole(PocUserRole pocUserRole)
Sets the value of the PoC-User-Role AVP, of type Grouped.
|
void |
setTalkBurstExchange(TalkBurstExchange talkBurstExchange)
Sets a single Talk-Burst-Exchange AVP in the PoC-Information AVP, of type Grouped.
|
void |
setTalkBurstExchanges(TalkBurstExchange[] talkBurstExchanges)
Sets the set of Talk-Burst-Exchange AVPs, with all the values in the given array.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasPocServerRole()
PocServerRole getPocServerRole()
void setPocServerRole(PocServerRole pocServerRole)
java.lang.NullPointerException
- if pocServerRole
is null
.void removePocServerRole()
boolean hasPocSessionType()
PocSessionType getPocSessionType()
void setPocSessionType(PocSessionType pocSessionType)
java.lang.NullPointerException
- if pocSessionType
is null
.void removePocSessionType()
boolean hasPocUserRole()
PocUserRole getPocUserRole()
void setPocUserRole(PocUserRole pocUserRole)
java.lang.NullPointerException
- if pocUserRole
is null
.void removePocUserRole()
boolean hasPocSessionInitiationType()
PocSessionInitiationType getPocSessionInitiationType()
void setPocSessionInitiationType(PocSessionInitiationType pocSessionInitiationType)
java.lang.NullPointerException
- if pocSessionInitiationType
is null
.void removePocSessionInitiationType()
boolean hasPocEventType()
PocEventType getPocEventType()
void setPocEventType(PocEventType pocEventType)
java.lang.NullPointerException
- if pocEventType
is null
.void removePocEventType()
boolean hasNumberOfParticipants()
long getNumberOfParticipants()
hasNumberOfParticipants()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Number-Of-Participants AVP has not been set.void setNumberOfParticipants(long numberOfParticipants)
void removeNumberOfParticipants()
java.lang.String[] getParticipantsInvolveds()
void setParticipantsInvolved(java.lang.String participantsInvolved)
java.lang.NullPointerException
- if participantsInvolved
is null
.void setParticipantsInvolveds(java.lang.String[] participantsInvolveds)
java.lang.NullPointerException
- if participantsInvolveds
is null
.void removeParticipantsInvolveds()
ParticipantGroup[] getParticipantGroups()
void setParticipantGroup(ParticipantGroup participantGroup)
java.lang.NullPointerException
- if participantGroup
is null
.void setParticipantGroups(ParticipantGroup[] participantGroups)
java.lang.NullPointerException
- if participantGroups
is null
.void removeParticipantGroups()
TalkBurstExchange[] getTalkBurstExchanges()
void setTalkBurstExchange(TalkBurstExchange talkBurstExchange)
java.lang.NullPointerException
- if talkBurstExchange
is null
.void setTalkBurstExchanges(TalkBurstExchange[] talkBurstExchanges)
java.lang.NullPointerException
- if talkBurstExchanges
is null
.void removeTalkBurstExchanges()
boolean hasPocControllingAddress()
java.lang.String getPocControllingAddress()
void setPocControllingAddress(java.lang.String pocControllingAddress)
java.lang.NullPointerException
- if pocControllingAddress
is null
.void removePocControllingAddress()
boolean hasPocGroupName()
java.lang.String getPocGroupName()
void setPocGroupName(java.lang.String pocGroupName)
java.lang.NullPointerException
- if pocGroupName
is null
.void removePocGroupName()
boolean hasPocSessionId()
java.lang.String getPocSessionId()
void setPocSessionId(java.lang.String pocSessionId)
java.lang.NullPointerException
- if pocSessionId
is null
.void removePocSessionId()
boolean hasChargedParty()
java.lang.String getChargedParty()
void setChargedParty(java.lang.String chargedParty)
java.lang.NullPointerException
- if chargedParty
is null
.void removeChargedParty()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
AvpNotAllowedException
- if an AVP is encountered of a type already known to this class
(i.e. an AVP for which get/set methods already appear in this class)java.lang.NullPointerException
- if avps
is null
.void removeExtensionAvps()