Bug #1127: Add comments to java oca getById methods

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.