SubmenuInfo

public class SubmenuInfo

Class to encapsulate information about sub-menu links to be shown on UI. This represents a link shown on the left side of the UI.

Constructors

SubmenuInfo

public SubmenuInfo()

SubmenuInfo

public SubmenuInfo(String url)

Constructs an instance for a given url.

Parameters:

• url – the url this links to

Methods

getCriticalMessage

public String getCriticalMessage()

Returns the critical message for this sub-menu, if it has been set.

Returns:the critical message for this link

getRoleForAccess

public List<String> getRoleForAccess()

Returns a list of permissions required to access this sub-menu item. It is required for the user to have at least permission from this, not all. This link will be hidden for users without the permissions.

Returns:the list of permissions for access

getUrl

public String getUrl()

Returns:the url this links to

isNeedsAttention

public boolean isNeedsAttention()

Returns:true if this sub-menu should be marked as requiring attention on the UI, false otherwise

setCriticalMessage

public void setCriticalMessage(String criticalMessage)

Sets the critical message for this sub-menu, it will displayed on the UI as a tooltip.

Parameters:

• criticalMessage – the critical message for this link

setNeedsAttention

public void setNeedsAttention(boolean needsAttention)

Parameters:

• needsAttention – true if this sub-menu should be marked as requiring attention on the UI, false otherwise

setRoleForAccess

public void setRoleForAccess(String roleForAccess)

setRoleForAccess

public void setRoleForAccess(List<String> roleForAccess)

Sets the list of permissions required to access this sub-menu item. It is required for the user to have at least permission from this, not all. This link will be hidden for users without the permissions.

Parameters:

• roleForAccess – the list of permissions for access

setUrl

public void setUrl(String url)

Parameters:

• url – the url this links to