net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature Interface Reference

import "NicAccess.idl";

Inheritance diagram for net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature:

net.juniper.smgt.gateway.nic.protocol.NicFeature List of all members.

Detailed Description

NIC Locator Interface.


Public Member Functions

AttrSeq getLocatorInfo ()
 The getLocatorInfo() method returns a sequence of attributes.
NicLocatorValue lookupSingle (in NicLocatorKey key) raises (NICException)
 The lookupSingle() method looks up and then returns one value for a key that the method receives.
NicLocatorValueSeq lookup (in NicLocatorKey key) raises (NICException)
 The lookup() method looks up and then returns the values for a key that the method receives.
NicLocatorResultSeq lookupBulk (in NicLocatorKeySeq keys) raises (NICException)
 The lookupBulk() method looks up and then returns the values for one or more keys that the method receives.


Member Function Documentation

AttrSeq net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.getLocatorInfo (  ) 

The getLocatorInfo() method returns a sequence of attributes.

The method returns the names of the following attributes:

Returns:
AttrSeq object that represents the configuration of the locator.

NicLocatorValueSeq net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.lookup ( in NicLocatorKey  key  )  raises (NICException)

The lookup() method looks up and then returns the values for a key that the method receives.

Parameters:
[in] key NIC key for which to locate and return a value. Specify the key in string format that conforms to the format of the NIC data type that this locator feature accepts. Constraints are optional.
Returns:
List of NicLocatorValue objects that represent the values mapped to the key. Each value for the NIC locator includes the intermediate values for this resolution. The list can contain more than one object with the same value, although intermediate values can differ.
Exceptions:
NICException Raised if the method does not find a value for the key.

NicLocatorResultSeq net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.lookupBulk ( in NicLocatorKeySeq  keys  )  raises (NICException)

The lookupBulk() method looks up and then returns the values for one or more keys that the method receives.

The method returns a list of values for each key.

Parameters:
[in] keys List of NIC keys for which to locate and return values. Specify each key in string format that conforms to the format of the NIC data type that this locator feature accepts. Constraints are optional.
Returns:
List of NicLocatorResult objects that represent the values for each key passed to the method.
Exceptions:
NICException Raised if a general exception occurs; that is, a problem not related to a specific key.

NicLocatorValue net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.lookupSingle ( in NicLocatorKey  key  )  raises (NICException)

The lookupSingle() method looks up and then returns one value for a key that the method receives.


If the method finds more than one value, the locator returns only one value.

If you want more than one value returned for a key, use the lookup() method.

Parameters:
[in] key NIC key for which to locate and return a value. Specify the key in string format that conforms to the format of the NIC data type that this locator feature accepts. Constraints are optional.
Returns:
NicLocatorValue object that represents the value mapped to the key.
Exceptions:
NICException Raised if the method does not find a value for the key.


The documentation for this interface was generated from the following file:
Generated on Fri Sep 25 17:50:16 2015 for NIC Access API by  doxygen 1.4.7