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

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:

PocInformationImpl

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

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

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

 7.2.78 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 ] 
      [ Number-Of-Participants ] 
    * [ Participants-Involved ] 
    * [ Talk-Burst-Exchange ] 
      [ PoC-Controlling-Address ] 
      [ PoC-Group-Name ] 
      [ PoC-Session-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

int	getNumberOfParticipants() Returns the value of the Number-Of-Participants AVP, of type Integer32.
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.
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.
PocSessionType	getPocSessionType() Returns the value of the PoC-Session-Type AVP, of type Enumerated.
TalkBurstExchange[]	getTalkBurstExchanges() Returns the set of Talk-Burst-Exchange AVPs.
boolean	hasNumberOfParticipants() Returns true if the Number-Of-Participants AVP is present in the message.
boolean	hasPocControllingAddress() Returns true if the PoC-Controlling-Address AVP is present in the message.
boolean	hasPocGroupName() Returns true if the PoC-Group-Name AVP is present in the message.
boolean	hasPocServerRole() Returns true if the PoC-Server-Role AVP is present in the message.
boolean	hasPocSessionId() Returns true if the PoC-Session-Id AVP is present in the message.
boolean	hasPocSessionType() Returns true if the PoC-Session-Type AVP is present in the message.
void	setNumberOfParticipants(int numberOfParticipants) Sets the value of the Number-Of-Participants AVP, of type Integer32.
void	setParticipantsInvolved(java.lang.String participantsInvolved) Sets a single Participants-Involved AVP in the message, 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	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	setPocSessionType(PocSessionType pocSessionType) Sets the value of the PoC-Session-Type AVP, of type Enumerated.
void	setTalkBurstExchange(TalkBurstExchange talkBurstExchange) Sets a single Talk-Burst-Exchange AVP in the message, of type Grouped.
void	setTalkBurstExchanges(TalkBurstExchange[] talkBurstExchanges) Sets the set of Talk-Burst-Exchange AVPs, with all the values in the given array.

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

getNumberOfParticipants

int getNumberOfParticipants()

Returns the value of the Number-Of-Participants AVP, of type Integer32. A return value of null implies that the AVP has not been set.

getParticipantsInvolveds

java.lang.String[] getParticipantsInvolveds()

Returns the set of Participants-Involved AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Participants-Involved AVPs have been set. The elements in the given array are String objects.

getPocControllingAddress

java.lang.String getPocControllingAddress()

Returns the value of the PoC-Controlling-Address AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getPocGroupName

java.lang.String getPocGroupName()

Returns the value of the PoC-Group-Name AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getPocServerRole

PocServerRole getPocServerRole()

Returns the value of the PoC-Server-Role AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getPocSessionId

java.lang.String getPocSessionId()

Returns the value of the PoC-Session-Id AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getPocSessionType

PocSessionType getPocSessionType()

Returns the value of the PoC-Session-Type AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getTalkBurstExchanges

TalkBurstExchange[] getTalkBurstExchanges()

Returns the set of Talk-Burst-Exchange AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Talk-Burst-Exchange AVPs have been set. The elements in the given array are TalkBurstExchange objects.

hasNumberOfParticipants

boolean hasNumberOfParticipants()

Returns true if the Number-Of-Participants AVP is present in the message.

hasPocControllingAddress

boolean hasPocControllingAddress()

Returns true if the PoC-Controlling-Address AVP is present in the message.

hasPocGroupName

boolean hasPocGroupName()

Returns true if the PoC-Group-Name AVP is present in the message.

hasPocServerRole

boolean hasPocServerRole()

Returns true if the PoC-Server-Role AVP is present in the message.

hasPocSessionId

boolean hasPocSessionId()

Returns true if the PoC-Session-Id AVP is present in the message.

hasPocSessionType

boolean hasPocSessionType()

Returns true if the PoC-Session-Type AVP is present in the message.

setNumberOfParticipants

void setNumberOfParticipants(int numberOfParticipants)

Sets the value of the Number-Of-Participants AVP, of type Integer32.

setParticipantsInvolved

void setParticipantsInvolved(java.lang.String participantsInvolved)

Sets a single Participants-Involved AVP in the message, of type UTF8String.

setParticipantsInvolveds

void setParticipantsInvolveds(java.lang.String[] participantsInvolveds)

Sets the set of Participants-Involved AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getParticipantsInvolveds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

setPocControllingAddress

void setPocControllingAddress(java.lang.String pocControllingAddress)

Sets the value of the PoC-Controlling-Address AVP, of type UTF8String.

setPocGroupName

void setPocGroupName(java.lang.String pocGroupName)

Sets the value of the PoC-Group-Name AVP, of type UTF8String.

setPocServerRole

void setPocServerRole(PocServerRole pocServerRole)

Sets the value of the PoC-Server-Role AVP, of type Enumerated.

setPocSessionId

void setPocSessionId(java.lang.String pocSessionId)

Sets the value of the PoC-Session-Id AVP, of type UTF8String.

setPocSessionType

void setPocSessionType(PocSessionType pocSessionType)

Sets the value of the PoC-Session-Type AVP, of type Enumerated.

setTalkBurstExchange

void setTalkBurstExchange(TalkBurstExchange talkBurstExchange)

Sets a single Talk-Burst-Exchange AVP in the message, of type Grouped.

setTalkBurstExchanges

void setTalkBurstExchanges(TalkBurstExchange[] talkBurstExchanges)

Sets the set of Talk-Burst-Exchange AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getTalkBurstExchanges() is not guaranteed to return the same array instance, e.g. an "==" check would fail.