NavigationButton (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.portal.NavigationButton

All Implemented Interfaces:

JSONable, JSONCacheable, AppianTypeHolder, java.io.Serializable

Deprecated.
The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
```
@Deprecated
public class NavigationButton
extends java.lang.Object
implements JSONCacheable, AppianTypeHolder, java.io.Serializable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LINK_TYPE_DIALOG` Deprecated.
`static int`	`LINK_TYPE_ENTIRE_WINDOW` Deprecated.
`static int`	`LINK_TYPE_NEW_WINDOW` Deprecated.
`static int`	`LINK_TYPE_PORTAL_CONTENT` Deprecated.

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT

Constructor Summary

Constructors
Constructor and Description

NavigationButton()
Deprecated.

Constructors
Constructor and Description
`NavigationButton()` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Deprecated. Compares two `NavigationButton` objects for equality.
`void`	`fillInAppianTypes(AppianTypeCache cache)` Deprecated. If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache.
`boolean`	`getCounter()` Deprecated.
`java.lang.Class`	`getCounterImplementation()` Deprecated.
`LocalObject[]`	`getExcludedPeople()` Deprecated.
`java.util.HashSet`	`getHiddenAttributes()` Deprecated. Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
`java.lang.String`	`getIcon()` Deprecated.
`java.lang.Long`	`getId()` Deprecated.
`java.lang.String`	`getKey()` Deprecated.
`java.lang.String`	`getLabel()` Deprecated.
`boolean`	`getLabelLocalized()` Deprecated.
`int`	`getLinkType()` Deprecated.
`java.lang.String`	`getPath()` Deprecated.
`boolean`	`getTargeted()` Deprecated.
`LocalObject[]`	`getTargetedPeople()` Deprecated.
`int`	`hashCode()` Deprecated. Returns the hashcode for this `NavigationButton`.
`void`	`setCounter(boolean counter)` Deprecated.
`void`	`setCounterImplementation(java.lang.Class counterImplementation)` Deprecated.
`void`	`setExcludedGroups(java.lang.Long[] excludedGroups)` Deprecated.
`void`	`setExcludedPeople(LocalObject[] excludedPeople)` Deprecated.
`void`	`setExcludedUsers(java.lang.String[] excludedUsers)` Deprecated.
`void`	`setIcon(java.lang.String icon)` Deprecated.
`void`	`setId(java.lang.Long id)` Deprecated.
`void`	`setKey(java.lang.String key)` Deprecated.
`void`	`setLabel(java.lang.String label)` Deprecated.
`void`	`setLabelLocalized(boolean labelLocalized)` Deprecated.
`void`	`setLinkType(int linkType)` Deprecated.
`void`	`setPath(java.lang.String path)` Deprecated.
`void`	`setTargeted(boolean targeted)` Deprecated.
`void`	`setTargetedGroups(java.lang.Long[] targetedGroups)` Deprecated.
`void`	`setTargetedPeople(LocalObject[] targetedPeople)` Deprecated.
`void`	`setTargetedUsers(java.lang.String[] targetedUsers)` Deprecated.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LINK_TYPE_PORTAL_CONTENT
```
public static final int LINK_TYPE_PORTAL_CONTENT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LINK_TYPE_NEW_WINDOW
```
public static final int LINK_TYPE_NEW_WINDOW
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LINK_TYPE_DIALOG
```
public static final int LINK_TYPE_DIALOG
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LINK_TYPE_ENTIRE_WINDOW
```
public static final int LINK_TYPE_ENTIRE_WINDOW
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NavigationButton
```
public NavigationButton()
```
    Deprecated.
- Method Detail
  - getHiddenAttributes
```
public java.util.HashSet getHiddenAttributes()
```
    Deprecated.
    
    Description copied from interface: JSONable
    
    Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
    
    Specified by:
    
    getHiddenAttributes in interface JSONable
    
    Returns:
    
    the set of hidden attributes
  - getLabelLocalized
```
public boolean getLabelLocalized()
```
    Deprecated.
  - setLabelLocalized
```
public void setLabelLocalized(boolean labelLocalized)
```
    Deprecated.
  - getCounter
```
public boolean getCounter()
```
    Deprecated.
  - setCounter
```
public void setCounter(boolean counter)
```
    Deprecated.
  - getCounterImplementation
```
public java.lang.Class getCounterImplementation()
```
    Deprecated.
  - setCounterImplementation
```
public void setCounterImplementation(java.lang.Class counterImplementation)
```
    Deprecated.
  - getIcon
```
public java.lang.String getIcon()
```
    Deprecated.
  - setIcon
```
public void setIcon(java.lang.String icon)
```
    Deprecated.
  - getId
```
public java.lang.Long getId()
```
    Deprecated.
  - setId
```
public void setId(java.lang.Long id)
```
    Deprecated.
  - getKey
```
public java.lang.String getKey()
```
    Deprecated.
  - setKey
```
public void setKey(java.lang.String key)
```
    Deprecated.
  - getLabel
```
public java.lang.String getLabel()
```
    Deprecated.
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Deprecated.
  - getLinkType
```
public int getLinkType()
```
    Deprecated.
  - setLinkType
```
public void setLinkType(int linkType)
```
    Deprecated.
  - getPath
```
public java.lang.String getPath()
```
    Deprecated.
  - setPath
```
public void setPath(java.lang.String path)
```
    Deprecated.
  - getTargeted
```
public boolean getTargeted()
```
    Deprecated.
  - setTargeted
```
public void setTargeted(boolean targeted)
```
    Deprecated.
  - setTargetedGroups
```
public void setTargetedGroups(java.lang.Long[] targetedGroups)
```
    Deprecated.
  - setTargetedUsers
```
public void setTargetedUsers(java.lang.String[] targetedUsers)
```
    Deprecated.
  - setExcludedGroups
```
public void setExcludedGroups(java.lang.Long[] excludedGroups)
```
    Deprecated.
  - setExcludedUsers
```
public void setExcludedUsers(java.lang.String[] excludedUsers)
```
    Deprecated.
  - getExcludedPeople
```
public LocalObject[] getExcludedPeople()
```
    Deprecated.
  - setExcludedPeople
```
public void setExcludedPeople(LocalObject[] excludedPeople)
```
    Deprecated.
  - getTargetedPeople
```
public LocalObject[] getTargetedPeople()
```
    Deprecated.
  - setTargetedPeople
```
public void setTargetedPeople(LocalObject[] targetedPeople)
```
    Deprecated.
  - fillInAppianTypes
```
public void fillInAppianTypes(AppianTypeCache cache)
```
    Deprecated.
    
    Description copied from interface: AppianTypeHolder
    
    If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache. Later, the cache will populate itself with the display strings that correspond to all of its ids, such as "Human Resources" for group 9.
    
    Specified by:
    
    fillInAppianTypes in interface AppianTypeHolder
    
    Parameters:
    
    cache - cache of Appian-typed objects.
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Returns the hashcode for this NavigationButton. Two NavigationButton objects that have the same key will have the same hashcode.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Deprecated.
    
    Compares two NavigationButton objects for equality. Two objects are equal if they have the same key.
    
    Overrides:
    
    equals in class java.lang.Object

Class NavigationButton

Field Summary

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LINK_TYPE_PORTAL_CONTENT

LINK_TYPE_NEW_WINDOW

LINK_TYPE_DIALOG

LINK_TYPE_ENTIRE_WINDOW

Constructor Detail

NavigationButton

Method Detail

getHiddenAttributes

getLabelLocalized

setLabelLocalized

getCounter

setCounter

getCounterImplementation

setCounterImplementation

getIcon

setIcon

getId

setId

getKey

setKey

getLabel

setLabel

getLinkType

setLinkType

getPath

setPath

getTargeted

setTargeted

setTargetedGroups

setTargetedUsers

setExcludedGroups

setExcludedUsers

getExcludedPeople

setExcludedPeople

getTargetedPeople

setTargetedPeople

fillInAppianTypes

hashCode

equals