From 5af252e48a4d7aad13a88328d567891e811e9fba Mon Sep 17 00:00:00 2001 From: Pramila Singh Date: Tue, 30 Apr 2013 13:41:06 -0700 Subject: [PATCH 1/1] Javadoc for controller.web Change-Id: Ie687bbb842391bf94f7c23a3c58833cf53a2e438 Signed-off-by: Pramila Singh --- .../controller/web/IDaylightWeb.java | 31 +++++++++++++++---- 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java b/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java index 84bbd94bae..55e3ee5110 100644 --- a/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java +++ b/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java @@ -1,4 +1,3 @@ - /* * 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; -/** - * - * - */ 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(); + /** + * Returns the Id assigned to the web bundle. + * + * @return Id assigned to the web bundle. + */ 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(); - + + /** + * 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); } -- 2.36.6