org.onosproject.vtnrsc.portpairgroup

Interface PortPairGroupService

All Superinterfaces:

org.onosproject.event.ListenerService<PortPairGroupEvent,PortPairGroupListener>

All Known Implementing Classes:

PortPairGroupManager

public interface PortPairGroupService
extends org.onosproject.event.ListenerService<PortPairGroupEvent,PortPairGroupListener>

Service for interacting with the inventory of port pair groups.

Method Summary

Modifier and Type	Method and Description
boolean	createPortPairGroup(PortPairGroup portPairGroup) Creates a PortPairGroup in the store.
boolean	exists(PortPairGroupId portPairGroupId) Returns if the port pair group is existed.
PortPairGroup	getPortPairGroup(PortPairGroupId portPairGroupId) Returns the portPairGroup with the given identifier.
int	getPortPairGroupCount() Returns the number of port pair groups known to the system.
Iterable<PortPairGroup>	getPortPairGroups() Returns an iterable collection of the currently known port pair groups.
boolean	removePortPairGroup(PortPairGroupId portPairGroupId) Deletes portPairGroup by given portPairGroupId.
boolean	updatePortPairGroup(PortPairGroup portPairGroup) Updates the portPairGroup in the store.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

exists

boolean exists(PortPairGroupId portPairGroupId)

Returns if the port pair group is existed.

Parameters:

portPairGroupId - port pair group identifier

Returns:

true or false if one with the given identifier exists.

getPortPairGroupCount

int getPortPairGroupCount()

Returns the number of port pair groups known to the system.

Returns:

number of port pair groups.

getPortPairGroups

Iterable<PortPairGroup> getPortPairGroups()

Returns an iterable collection of the currently known port pair groups.

Returns:

collection of port pair groups.

getPortPairGroup

PortPairGroup getPortPairGroup(PortPairGroupId portPairGroupId)

Returns the portPairGroup with the given identifier.

Parameters:

portPairGroupId - port pair group identifier

Returns:

PortPairGroup or null if port pair group with the given identifier is not known.

createPortPairGroup

boolean createPortPairGroup(PortPairGroup portPairGroup)

Creates a PortPairGroup in the store.

Parameters:

portPairGroup - the port pair group to create

Returns:

true if given port pair group is created successfully.

updatePortPairGroup

boolean updatePortPairGroup(PortPairGroup portPairGroup)

Updates the portPairGroup in the store.

Parameters:

portPairGroup - the port pair group to update

Returns:

true if given port pair group is updated successfully.

removePortPairGroup

boolean removePortPairGroup(PortPairGroupId portPairGroupId)

Deletes portPairGroup by given portPairGroupId.

Parameters:

portPairGroupId - id of port pair group to remove

Returns:

true if the give port pair group is deleted successfully.