Coverage Report - pt.digitalis.dif.dem.interfaces.IRegistrable
 
Classes in this File Line Coverage Branch Coverage Complexity
IRegistrable
N/A
N/A
1
 
 1  
 /**
 2  
  * - Digitalis Internal Framework v2.0 - (C) 2007, Digitalis Informatica. Distribuicao e Gestao de Informatica, Lda.
 3  
  * Estrada de Paco de Arcos num.9 - Piso -1 2780-666 Paco de Arcos Telefone: (351) 21 4408990 Fax: (351) 21 4408999
 4  
  * http://www.digitalis.pt
 5  
  */
 6  
 package pt.digitalis.dif.dem.interfaces;
 7  
 
 8  
 import pt.digitalis.dif.dem.objects.LicenseEditionType;
 9  
 
 10  
 /**
 11  
  * This interface exposes behavior related to Entity registry.
 12  
  * 
 13  
  * @author Rodrigo Gonçalves <a href="mailto:rgoncalves@digitalis.pt">rgoncalves@digitalis.pt</a>
 14  
  * @created 2007/05/03
 15  
  */
 16  
 public interface IRegistrable {
 17  
 
 18  
     /**
 19  
      * Get the License Edition.
 20  
      * 
 21  
      * @return {@link LicenseEditionType}
 22  
      */
 23  
     public LicenseEditionType getLicenseEdition();
 24  
 
 25  
     /**
 26  
      * Returns information about if the Entity is registered.
 27  
      * 
 28  
      * @return T if the Entity is registered, F otherwise
 29  
      */
 30  
     public boolean isRegistered();
 31  
 
 32  
     /**
 33  
      * Returns information about if the Entity can be registered.
 34  
      * 
 35  
      * @return T if the Entity is registrable, F otherwise
 36  
      */
 37  
     public boolean isRegistrable();
 38  
 
 39  
     /**
 40  
      * Registers the Entity with a given key.
 41  
      * 
 42  
      * @param name
 43  
      *            the name to register to
 44  
      * @param key
 45  
      *            the encripted registration key
 46  
      * @return T if the Entity was successfully registered, F otherwise
 47  
      */
 48  
     public boolean register(String name, String key);
 49  
 
 50  
     /**
 51  
      * Unregisters the Entity.
 52  
      */
 53  
     public void unregister();
 54  
 
 55  
 }