Javadoc for controller.web
[controller.git] / opendaylight / web / root / src / main / java / org / opendaylight / controller / web / IDaylightWeb.java
index 84bbd94..55e3ee5 100644 (file)
@@ -1,4 +1,3 @@
-
 /*
  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
  *
 /*
  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
  *
@@ -11,16 +10,36 @@ package org.opendaylight.controller.web;
 
 import org.opendaylight.controller.sal.authorization.UserLevel;
 
 
 import org.opendaylight.controller.sal.authorization.UserLevel;
 
-/**
- *
- *
- */
 public interface IDaylightWeb {
 public interface IDaylightWeb {
+    /**
+     * Returns the name of the bundle. In the GUI, this name will be displayed
+     * on the tab.
+     * 
+     * @return Name assigned to the bundle.
+     */
     public String getWebName();
 
     public String getWebName();
 
+    /**
+     * Returns the Id assigned to the web bundle.
+     * 
+     * @return Id assigned to the web bundle.
+     */
     public String getWebId();
 
     public String getWebId();
 
+    /**
+     * Returns the position where the bundle tab will be placed in the GUI.
+     * 
+     * @return Position number for the bundle tab.
+     */
     public short getWebOrder();
     public short getWebOrder();
-    
+
+    /**
+     * This method checks if the user is authorized to access the bundle.
+     * 
+     * @param userLevel
+     *            user role level in the controller space.
+     * 
+     * @return true, if user is authorized to access the bundle, else false.
+     */
     public boolean isAuthorized(UserLevel userLevel);
 }
     public boolean isAuthorized(UserLevel userLevel);
 }