From c73248643d442abc9939a1ad3a4775dc8b0d189f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Carlos=20Mart=C3=ADn?= <cmartins@fdi.ucm.es>
Date: Fri, 20 Apr 2012 12:20:26 +0300
Subject: [PATCH] Bug #1127: Add comments to java oca getById methods

---
 src/oca/java/src/org/opennebula/client/Pool.java                | 2 +-
 src/oca/java/src/org/opennebula/client/acl/AclPool.java         | 2 +-
 src/oca/java/src/org/opennebula/client/cluster/ClusterPool.java | 2 +-
 .../java/src/org/opennebula/client/datastore/DatastorePool.java | 2 +-
 src/oca/java/src/org/opennebula/client/group/GroupPool.java     | 2 +-
 src/oca/java/src/org/opennebula/client/host/HostPool.java       | 2 +-
 src/oca/java/src/org/opennebula/client/image/ImagePool.java     | 2 +-
 .../java/src/org/opennebula/client/template/TemplatePool.java   | 2 +-
 src/oca/java/src/org/opennebula/client/user/UserPool.java       | 2 +-
 .../java/src/org/opennebula/client/vm/VirtualMachinePool.java   | 2 +-
 .../java/src/org/opennebula/client/vnet/VirtualNetworkPool.java | 2 +-
 11 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/oca/java/src/org/opennebula/client/Pool.java b/src/oca/java/src/org/opennebula/client/Pool.java
index e383771952..69d694bcfd 100644
--- a/src/oca/java/src/org/opennebula/client/Pool.java
+++ b/src/oca/java/src/org/opennebula/client/Pool.java
@@ -205,7 +205,7 @@ public abstract class Pool{
 
     /**
      * Returns the element with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the element to retrieve
      * @return The element with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/acl/AclPool.java b/src/oca/java/src/org/opennebula/client/acl/AclPool.java
index 38db50fd26..05022419a9 100644
--- a/src/oca/java/src/org/opennebula/client/acl/AclPool.java
+++ b/src/oca/java/src/org/opennebula/client/acl/AclPool.java
@@ -91,7 +91,7 @@ public class AclPool extends Pool implements Iterable<Acl>{
 
     /**
      * Returns the ACl rule with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the ACl rule to retrieve
      * @return The ACl rule with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/cluster/ClusterPool.java b/src/oca/java/src/org/opennebula/client/cluster/ClusterPool.java
index e3172d42a9..49e25f419b 100644
--- a/src/oca/java/src/org/opennebula/client/cluster/ClusterPool.java
+++ b/src/oca/java/src/org/opennebula/client/cluster/ClusterPool.java
@@ -91,7 +91,7 @@ public class ClusterPool extends Pool implements Iterable<Cluster>{
 
     /**
      * Returns the Cluster with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the Cluster to retrieve
      * @return The Image with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/datastore/DatastorePool.java b/src/oca/java/src/org/opennebula/client/datastore/DatastorePool.java
index 6cdcef7416..299e622621 100644
--- a/src/oca/java/src/org/opennebula/client/datastore/DatastorePool.java
+++ b/src/oca/java/src/org/opennebula/client/datastore/DatastorePool.java
@@ -91,7 +91,7 @@ public class DatastorePool extends Pool implements Iterable<Datastore>{
 
     /**
      * Returns the Datastore with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the Datastore to retrieve
      * @return The Image with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/group/GroupPool.java b/src/oca/java/src/org/opennebula/client/group/GroupPool.java
index 3b769d7c73..14925af4ab 100644
--- a/src/oca/java/src/org/opennebula/client/group/GroupPool.java
+++ b/src/oca/java/src/org/opennebula/client/group/GroupPool.java
@@ -91,7 +91,7 @@ public class GroupPool extends Pool implements Iterable<Group>{
 
     /**
      * Returns the Group with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the Group to retrieve
      * @return The Image with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/host/HostPool.java b/src/oca/java/src/org/opennebula/client/host/HostPool.java
index c6330b5cef..d44fc847da 100644
--- a/src/oca/java/src/org/opennebula/client/host/HostPool.java
+++ b/src/oca/java/src/org/opennebula/client/host/HostPool.java
@@ -91,7 +91,7 @@ public class HostPool extends Pool implements Iterable<Host>{
 
     /**
      * Returns the Host with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the Host to retrieve
      * @return The Image with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/image/ImagePool.java b/src/oca/java/src/org/opennebula/client/image/ImagePool.java
index 5457ffafba..99ee470f1c 100644
--- a/src/oca/java/src/org/opennebula/client/image/ImagePool.java
+++ b/src/oca/java/src/org/opennebula/client/image/ImagePool.java
@@ -251,7 +251,7 @@ public class ImagePool extends Pool implements Iterable<Image>
 
     /**
      * Returns the Image with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the Image to retrieve
      * @return The Image with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/template/TemplatePool.java b/src/oca/java/src/org/opennebula/client/template/TemplatePool.java
index b48a4cd34c..640b8dd75a 100644
--- a/src/oca/java/src/org/opennebula/client/template/TemplatePool.java
+++ b/src/oca/java/src/org/opennebula/client/template/TemplatePool.java
@@ -251,7 +251,7 @@ public class TemplatePool extends Pool implements Iterable<Template>
 
     /**
      * Returns the Template with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the ACl rule to retrieve
      * @return The Template with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/user/UserPool.java b/src/oca/java/src/org/opennebula/client/user/UserPool.java
index 2e16d7c9de..58e4cb5a2a 100644
--- a/src/oca/java/src/org/opennebula/client/user/UserPool.java
+++ b/src/oca/java/src/org/opennebula/client/user/UserPool.java
@@ -89,7 +89,7 @@ public class UserPool extends Pool implements Iterable<User>{
 
     /**
      * Returns the User with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the User to retrieve
      * @return The Image with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/vm/VirtualMachinePool.java b/src/oca/java/src/org/opennebula/client/vm/VirtualMachinePool.java
index 5c08541934..9fc1de28fd 100644
--- a/src/oca/java/src/org/opennebula/client/vm/VirtualMachinePool.java
+++ b/src/oca/java/src/org/opennebula/client/vm/VirtualMachinePool.java
@@ -275,7 +275,7 @@ public class VirtualMachinePool extends Pool implements Iterable<VirtualMachine>
 
     /**
      * Returns the Virtual Machine with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the ACl rule to retrieve
      * @return The Virtual Machine with the given Id, or null if it was not found.
diff --git a/src/oca/java/src/org/opennebula/client/vnet/VirtualNetworkPool.java b/src/oca/java/src/org/opennebula/client/vnet/VirtualNetworkPool.java
index 7052404181..2b3ca56125 100644
--- a/src/oca/java/src/org/opennebula/client/vnet/VirtualNetworkPool.java
+++ b/src/oca/java/src/org/opennebula/client/vnet/VirtualNetworkPool.java
@@ -249,7 +249,7 @@ public class VirtualNetworkPool extends Pool implements Iterable<VirtualNetwork>
 
     /**
      * Returns the Virtual Network with the given Id from the pool. If it is not found,
-     * then returns null.
+     * then returns null. The method {@link #info()} must be called before.
      *
      * @param id of the Virtual Network to retrieve
      * @return The Image with the given Id, or null if it was not found.