Commit 3182c2ff authored by nshah's avatar nshah

OCVET-266, checking in changes from Mark M supplied patch, 24/Apr/13, 2:38pm

parent a67cb412
......@@ -36,10 +36,29 @@ public abstract class NetManager {
public abstract NetList getNetModuleList(PropertyFilter filter);
/**
* Returns NetModule by device and module ID.
* Returns all NetModules that match the specified device name and module identifier.
* Passing a null or empty device name with a non-null module identifier will result in a <code>NetList</code>
* containing all NetModules whose module ids match the non-null module identifier.
*
* Passing a null or empty module identifier with a non-null device name will result in a <code>NetList</code> * containing all NetModules whose devices match the non-null device name.
*
* Passing a null or empty module identifer and null or empty device name will return in a
* <code>NetList</code> with all known devices and sub-devices.
*
* @param deviceName name of the device hosting the module to retrieve
* @param moduleID Device unique module ID
* @param moduleID module identifier
*
* @return List of NetModules satisfying device name and module identifier
*/
public abstract NetList getNetModuleList(String deviceName, String moduleID);
/**
* Returns NetModule by device and module ID. If multiple devices have the same device name
* and share the same module identifier, then the value returned by this method is
* implementation specific.
*
* @param deviceName name of the device hosting the module to retrieve
* @param moduleID module identifier
*
* @return NetModule with the specified identifier
*/
......@@ -48,7 +67,7 @@ public abstract class NetManager {
/**
* Returns devices that match all properties set by a given filter.
* All known devices and sub-devices are passed through the given
* filter. Passing a null filter will return a NetList with all
* filter. Passing a null filter will return a <code>NetList</code> with all
* known devices and sub-devices.
*
* @param filter
......@@ -58,6 +77,17 @@ public abstract class NetManager {
*/
public abstract NetList getDeviceList(PropertyFilter filter);
/**
* Returns all devices that match the specified device name.
* Passing a null or empty device name will result in an
* empty <code>NetList</code>.
*
* @param name
* Device name.
* @return List of devices satisfying device name
*/
public abstract NetList getDeviceList(String name);
/**
* Returns device by name, for example, "BallRoom:DVD_PLAYER1".
* If multiple devices have the same name, then the value returned
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment