com.appiancorp.suiteapi.applications

Class ApplicationNavigationItem

java.lang.Object

com.appiancorp.suiteapi.applications.ApplicationNavigationItem

All Implemented Interfaces:

java.lang.Cloneable

public final class ApplicationNavigationItem
extends java.lang.Object
implements java.lang.Cloneable

Represents each item in the navigation definition of the application.

Constructor Summary

Constructors

Constructor and Description
ApplicationNavigationItem()
ApplicationNavigationItem(java.lang.String displayName, java.lang.String pageUuid, java.lang.String urlIdentifier)

Method Summary

Modifier and Type	Method and Description
ApplicationNavigationItem	clone()
java.lang.String	getDisplayName() Retrieves the display name of the navigation item.
java.lang.String	getPageUuid() Retrieves the UUID of the page targeted by the navigation item.
java.lang.String	getUrlIdentifier() Retrieves the URL identifier which will allow direct access to the navigation item.
void	setDisplayName(java.lang.String displayName) Sets the display name of the navigation item.
void	setPageUuid(java.lang.String pageUuid) Sets the UUID of the page targeted by the navigation item.
void	setUrlIdentifier(java.lang.String urlIdentifier) Sets the URL identifier which will allow direct access to the navigation item.
void	validate() Validates that this ApplicationNavigationItem is correct.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationNavigationItem

public ApplicationNavigationItem()

ApplicationNavigationItem

public ApplicationNavigationItem(java.lang.String displayName,
                                 java.lang.String pageUuid,
                                 java.lang.String urlIdentifier)

Method Detail

clone

public ApplicationNavigationItem clone()

Overrides:

clone in class java.lang.Object

validate

public void validate()
              throws InvalidNavigationItemException

Validates that this ApplicationNavigationItem is correct. A valid Item consists of a Non-empty displayName and pageUuid, and a valid urlIdentifier (only letters, numbers, dashes, underscores, less than 256 characters).

Throws:

InvalidNavigationItemException - If any of the checks is not met.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of the navigation item.

Parameters:

displayName -

getDisplayName

public java.lang.String getDisplayName()

Retrieves the display name of the navigation item.

Returns:

the display name for this navigation element

setPageUuid

public void setPageUuid(java.lang.String pageUuid)

Sets the UUID of the page targeted by the navigation item.

Parameters:

pageUuid -

getPageUuid

@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.String getPageUuid()

Retrieves the UUID of the page targeted by the navigation item.

Returns:

the UUID

setUrlIdentifier

public void setUrlIdentifier(java.lang.String urlIdentifier)

Sets the URL identifier which will allow direct access to the navigation item.

Parameters:

urlIdentifier - The URL identifier

getUrlIdentifier

public java.lang.String getUrlIdentifier()

Retrieves the URL identifier which will allow direct access to the navigation item.

Returns:

the URL identifier of this navigation item