jain.protocol.ss7.oam.mtp3
Interface LinkSetMO


public abstract interface LinkSetMO
extends Mtp3ManagedObject

This inteface defines the methods of a LinkSet to an adjacent node. Managed Object(MO).


Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 int getActiveLinkCount()
          Returns the number of links that should be active (alligned and ready for service) in this LinkSet at all times.
 Mtp3SapMO getAdjacentSignallingPoint()
          Gets the Adjacent Signalling Point of this Link Set.
 LinkSetMO[] getCombinedLinkSet()
          Returns an array of the LinkSet Managed Objects with which this LinkSet is combined.
 LinkSetMO getCombinedLinkSet(int index)
          Returns the LinkSet at the specified position in the array of the LinkSet Managed Objects with which this LinkSet is combined.
 int getCurrentCapacity()
          Returns the Current Capacity of this Link Set.
 LinkMO[] getLink()
          Gets the list of signalling links of this link set
 LinkMO getLink(int index)
          Gets the signalling link at the specified position in the set of links of this link set
 int getLinkCount()
          Gets the Number of this Link Set.
 int getMaxCapacity()
          Returns the Maximum Capacity of this Link Set.
 boolean isAllLinksActive()
          Returns whether all the Links in this LinkSet are active or innactive.
 boolean isCombinedLinkSet()
          Returns whether this LinkSet is a combined Link Set
 boolean isEnabled()
          Returns whether this LinkSet is enabled or disabled (the operational state of this LinkSet).
 boolean isRoutingAllowed()
          Returns whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via this LinkSet (the Adiministrative State).
 boolean isTestedPeriodically()
          This attribute indicates whether the periodic test procedure of ITU Rec.
 void setActiveLinkCount(int numberOfActiveLinks)
          Sets the number of links that should be active (alligned and ready for service) in this LinkSet at all times.
 void setAdjacentSignallingPoint(Mtp3SapMO adjacentSignallingPoint)
          Sets the Adjacent Signalling Point of this Link Set.
 void setAllLinksActive(boolean active)
          Activates or deactivates all the Links in this LinkSet.
 void setCombinedLinkSet(int index, LinkSetMO linkSet)
          Sets the LinkSetMO at the specified position in the combined link set of this link set
 void setCombinedLinkSet(LinkSetMO[] linkSets)
          Sets the combined Link Set of this link set
 void setEnabled(boolean enabled)
          Sets the operational state of this LinkSet.
 void setLink(int index, LinkMO link)
          Sets the Signalling Link at the specified position in the set of links of this link set
 void setLink(LinkMO[] links)
          Sets the Signalling Links of this link set
 void setMaxCapacity(int capacity)
          Sets the Maximum Capacity of this Link Set.
 void setRoutingAllowed(boolean allowed)
          Sets whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via this LinkSet (the Adiministrative State).
 
Methods inherited from interface jain.protocol.ss7.oam.mtp3.Mtp3ManagedObject
addMtp3AlarmListener, addMtp3ErrorListener, removeMtp3AlarmListener, removeMtp3ErrorListener
 
Methods inherited from interface jain.protocol.ss7.oam.OamManagedObject
addPropertyChangeListener, getName, getProprietaryInformation, removePropertyChangeListener, setName
 

Method Detail

getAdjacentSignallingPoint

public Mtp3SapMO getAdjacentSignallingPoint()
Gets the Adjacent Signalling Point of this Link Set.
Returns:
the Adjacent Signalling Point

setAdjacentSignallingPoint

public void setAdjacentSignallingPoint(Mtp3SapMO adjacentSignallingPoint)
Sets the Adjacent Signalling Point of this Link Set.
Parameters:
adjacentSignallingPoint - the Adjacent Signalling Point of this Link Set.

setMaxCapacity

public void setMaxCapacity(int capacity)
Sets the Maximum Capacity of this Link Set. The maximum capacity of a signalling linkset is the maximum load that should be placed on the linkset, when all links that could be active in the linkset are, and are working in service.
Parameters:
capacity - the maximum capacity of the Link Set

getMaxCapacity

public int getMaxCapacity()
Returns the Maximum Capacity of this Link Set. The maximum capacity of a signalling linkset is the maximum load that should be placed on the linkset, when all links that could be active in the linkset are, and are working in service.
Returns:
the maximum capacity of the Link Set

getCurrentCapacity

public int getCurrentCapacity()
Returns the Current Capacity of this Link Set. The current capacity of signalling linkset is the sum of the current capacities of the signalling links (or over the maximum capacities where the current capacities of the links of the linkset are not defined) which are active, working and in service. This is a display only attribute.
Returns:
the Current Capacity of the Link Set

setAllLinksActive

public void setAllLinksActive(boolean active)
Activates or deactivates all the Links in this LinkSet.
Parameters:
active - either:
  • true This activates all the Links in this LinkSet.
  • false This deactivates all the Links in this LinkSet.

isAllLinksActive

public boolean isAllLinksActive()
Returns whether all the Links in this LinkSet are active or innactive.
Returns:
either:
  • true All the links are active
  • false All the links are innactive

getLinkCount

public int getLinkCount()
Gets the Number of this Link Set.
Returns:
the Number of this Link Set.

isEnabled

public boolean isEnabled()
Returns whether this LinkSet is enabled or disabled (the operational state of this LinkSet).
Returns:
either:
  • true if this LinkSet is enabled.
  • false if this LinkSet is disabled.

setEnabled

public void setEnabled(boolean enabled)
Sets the operational state of this LinkSet.
Parameters:
enabled - the opertaional state (enabled or disabled) either:
  • true enables this LinkSet.
  • false disables this LinkSet.

setRoutingAllowed

public void setRoutingAllowed(boolean allowed)
Sets whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via this LinkSet (the Adiministrative State).
Parameters:
allowed - either:
  • true if routing is permitted (unlocked).
  • false otherwise (locked).

isRoutingAllowed

public boolean isRoutingAllowed()
Returns whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via this LinkSet (the Adiministrative State).
Returns:
either:
  • true if routing is permitted (unlocked).
  • false otherwise (locked).

isTestedPeriodically

public boolean isTestedPeriodically()
This attribute indicates whether the periodic test procedure of ITU Rec. Q.707 is applied to the links in this signalling linkset.
Returns:
either:
  • true if the links are tested periodically.
  • false otherwise.

getLink

public LinkMO[] getLink()
Gets the list of signalling links of this link set
Returns:
an array of all the signalling links in this link set

setLink

public void setLink(int index,
                    LinkMO link)
             throws TooManyInstancesException
Sets the Signalling Link at the specified position in the set of links of this link set
Parameters:
index - the index position of the element in the array.
link - the Signalling link to be added to this link set.
Throws:
TooManyInstancesException - - if the supplied index is greater than the number of Links permitted by this implementation.

getLink

public LinkMO getLink(int index)
Gets the signalling link at the specified position in the set of links of this link set
Parameters:
index - the index position of the element in the array.
Returns:
an array of all the signalling links in this link set

setLink

public void setLink(LinkMO[] links)
             throws TooManyInstancesException
Sets the Signalling Links of this link set
Parameters:
links - the Signalling links to be added to this link set.
Throws:
TooManyInstancesException - - if the size of links is greater than the number of Links permitted by this implementation.

getCombinedLinkSet

public LinkSetMO[] getCombinedLinkSet()
Returns an array of the LinkSet Managed Objects with which this LinkSet is combined.

getCombinedLinkSet

public LinkSetMO getCombinedLinkSet(int index)
Returns the LinkSet at the specified position in the array of the LinkSet Managed Objects with which this LinkSet is combined.
Parameters:
index - the index of the LinkSet in the Combined LinkSet array

setCombinedLinkSet

public void setCombinedLinkSet(int index,
                               LinkSetMO linkSet)
                        throws TooManyInstancesException
Sets the LinkSetMO at the specified position in the combined link set of this link set
Parameters:
index - the index position of the element in the array.
linkSet - the link set to be combined with this link set.
Throws:
TooManyInstancesException - - if the supplied index is greater than the number of LinkSetMOs permitted in a combined LinkSet by this implementation.

setCombinedLinkSet

public void setCombinedLinkSet(LinkSetMO[] linkSets)
Sets the combined Link Set of this link set
Parameters:
linkSets - the Signalling link sets to be combined with this link set.
Throws:
TooManyInstancesException - - if the size of linkSets is greater than the number of LinkSetMOs permitted in a combined LinkSet by this implementation.

getActiveLinkCount

public int getActiveLinkCount()
Returns the number of links that should be active (alligned and ready for service) in this LinkSet at all times. This attribute represents the number of normally active signalling links in this LinkSet. i.e. - the number of links in the LinkSet that are to be aligned and ready for service at all times.
Returns:
the specified number of active links

setActiveLinkCount

public void setActiveLinkCount(int numberOfActiveLinks)
Sets the number of links that should be active (alligned and ready for service) in this LinkSet at all times. This attribute represents the number of normally active signalling links in this LinkSet. i.e. - the number of links in the LinkSet that are to be aligned and ready for service at all times.
Parameters:
numberOfActiveLinks - the required number of active links

isCombinedLinkSet

public boolean isCombinedLinkSet()
Returns whether this LinkSet is a combined Link Set


11 October 99
If you have any comments or queries, please mail them to JainOAM@East.Sun.Com

Copyright - 1999 Sun Microsystems