Group

java.lang.Object
- com.endeca.portal.attributes.model.BasePropertyContainer
- - com.endeca.portal.attributes.viewmodel.Group

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Group
extends BasePropertyContainer
implements java.lang.Cloneable
```
Represents a group object serializable via Jackson

Author:

Endeca Technologies, Inc

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE_KEYS_PROPERTY`
`static java.util.List<java.lang.String>`	`DEFAULT_HIDDEN_NAV_GROUPS`
`static java.util.List<java.lang.String>`	`DEFAULT_HIDDEN_REC_DTL_GROUPS`
`static java.lang.String`	`DETAILS_GROUP_KEY`
`static java.lang.String`	`DISPLAY_NAME_PROPERTY`
`static java.lang.String`	`GENERAL_GROUP_KEY`
`static java.lang.String`	`GEOSPATIAL_GROUP_KEY`
`static java.lang.String`	`INCLUDE_IN_NAVIGATION_PROPERTY`
`static java.lang.String`	`INCLUDE_IN_RECORD_PROPERTY`
`static java.lang.String`	`IS_CATCHALL_PROPERTY`
`static java.lang.String`	`IS_DYNAMIC_PROPERTY`
`static java.lang.String`	`LOCALIZED_DISPLAY_NAME_PROPERTY`
`static java.lang.String`	`RECORD_IDENTIFIER_GROUP_KEY`
`static java.lang.String`	`SORT_PROPERTY`

Fields inherited from class com.endeca.portal.attributes.model.BasePropertyContainer
KEY_PROPERTY, properties

Constructor Summary

Constructors
Constructor and Description

Group()

Constructors
Constructor and Description
`Group()`

Method Summary

Methods
Modifier and Type	Method and Description
`Group`	`clone()`
`static java.lang.String`	`formGeneralGroupKey(java.lang.String viewKey)` Forms the group key to be used for a view's "General" attribute group.
`static java.lang.String`	`formGroupKey(java.lang.String viewKey, java.lang.String groupKey)` Forms a group key based on the specified view key.
`java.util.List<java.lang.String>`	`getAttributeKeys()`
`java.lang.String`	`getDisplayName()`
`java.lang.String`	`getDisplayName(java.util.Locale locale)` Get display name by locale settings
`java.lang.String`	`getDisplayName(javax.portlet.PortletRequest request)` Get display name by request
`java.lang.String`	`getDisplayName(java.lang.String languageId)` Get display name bu language id
`java.lang.String`	`getLocalizedDisplayName()`
`java.lang.String`	`getOriginGroupKey(java.lang.String viewKey)` Gets the origin group key without the viewKey prefix.
`java.lang.String`	`getSort()`
`boolean`	`isCatchAll()`
`boolean`	`isDynamic()`
`boolean`	`isIncludeInNavigation()`
`boolean`	`isIncludeInRecord()`
`void`	`setAttributeKeys(java.util.List<java.lang.String> attributeKeys)`
`void`	`setCatchAll(boolean isCatchAll)` Sets whether or not this is a catch-all group
`void`	`setDisplayName(java.lang.String displayName)`
`void`	`setDynamic(boolean isDynamic)` Sets whether or not this is a dynamic group
`void`	`setIncludeInNavigation(boolean includeInNavigation)` Sets whether or not the group include in Navigation
`void`	`setIncludeInRecord(boolean includeInRecord)` Sets whether or not the group include in record
`void`	`setLocalizedDisplayName(java.lang.String displayName)`
`void`	`setSort(java.lang.String sort)`

Methods inherited from class com.endeca.portal.attributes.model.BasePropertyContainer
addProperty, getKey, getProperties, getProperty, getProperty, isEmpty, isValid, setKey, setProperties, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DISPLAY_NAME_PROPERTY
```
public static final java.lang.String DISPLAY_NAME_PROPERTY
```
    See Also:
    Constant Field Values
  - LOCALIZED_DISPLAY_NAME_PROPERTY
```
public static final java.lang.String LOCALIZED_DISPLAY_NAME_PROPERTY
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_KEYS_PROPERTY
```
public static final java.lang.String ATTRIBUTE_KEYS_PROPERTY
```
    See Also:
    Constant Field Values
  - IS_DYNAMIC_PROPERTY
```
public static final java.lang.String IS_DYNAMIC_PROPERTY
```
    See Also:
    Constant Field Values
  - SORT_PROPERTY
```
public static final java.lang.String SORT_PROPERTY
```
    See Also:
    Constant Field Values
  - INCLUDE_IN_NAVIGATION_PROPERTY
```
public static final java.lang.String INCLUDE_IN_NAVIGATION_PROPERTY
```
    See Also:
    Constant Field Values
  - INCLUDE_IN_RECORD_PROPERTY
```
public static final java.lang.String INCLUDE_IN_RECORD_PROPERTY
```
    See Also:
    Constant Field Values
  - IS_CATCHALL_PROPERTY
```
public static final java.lang.String IS_CATCHALL_PROPERTY
```
    See Also:
    Constant Field Values
  - RECORD_IDENTIFIER_GROUP_KEY
```
public static final java.lang.String RECORD_IDENTIFIER_GROUP_KEY
```
    See Also:
    Constant Field Values
  - DETAILS_GROUP_KEY
```
public static final java.lang.String DETAILS_GROUP_KEY
```
    See Also:
    Constant Field Values
  - GENERAL_GROUP_KEY
```
public static final java.lang.String GENERAL_GROUP_KEY
```
    See Also:
    Constant Field Values
  - GEOSPATIAL_GROUP_KEY
```
public static final java.lang.String GEOSPATIAL_GROUP_KEY
```
    See Also:
    Constant Field Values
  - DEFAULT_HIDDEN_NAV_GROUPS
```
public static final java.util.List<java.lang.String> DEFAULT_HIDDEN_NAV_GROUPS
```
  - DEFAULT_HIDDEN_REC_DTL_GROUPS
```
public static final java.util.List<java.lang.String> DEFAULT_HIDDEN_REC_DTL_GROUPS
```
- Constructor Detail
  - Group
```
public Group()
```
- Method Detail
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Parameters:
    displayName - the displayName to set
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Returns:
    the displayName
  - getDisplayName
```
public java.lang.String getDisplayName(java.lang.String languageId)
```
    Get display name bu language id
    
    Parameters:
    languageId -
    
    Returns:
  - getDisplayName
```
public java.lang.String getDisplayName(java.util.Locale locale)
```
    Get display name by locale settings
    
    Parameters:
    locale -
    
    Returns:
  - getDisplayName
```
public java.lang.String getDisplayName(javax.portlet.PortletRequest request)
```
    Get display name by request
    
    Parameters:
    locale -
    
    Returns:
  - setLocalizedDisplayName
```
public void setLocalizedDisplayName(java.lang.String displayName)
```
    Parameters:
    LocalizedDisplayName - the LocalizedDisplayName to set
  - getLocalizedDisplayName
```
public java.lang.String getLocalizedDisplayName()
```
    Returns:
    the LocalizedDisplayName
  - isDynamic
```
public boolean isDynamic()
```
    Returns:
    true if this is a "dynamic" group
  - setDynamic
```
public void setDynamic(boolean isDynamic)
```
    Sets whether or not this is a dynamic group
    
    Parameters:
    isDynamic -
  - setSort
```
public void setSort(java.lang.String sort)
```
    Parameters:
    sort - the sort information to set
  - getSort
```
public java.lang.String getSort()
```
    Returns:
    the sort information
  - isIncludeInNavigation
```
public boolean isIncludeInNavigation()
```
    Returns:
    true if the group include in Navigation
  - setIncludeInNavigation
```
public void setIncludeInNavigation(boolean includeInNavigation)
```
    Sets whether or not the group include in Navigation
    
    Parameters:
    includeInNavigation -
  - isIncludeInRecord
```
public boolean isIncludeInRecord()
```
    Returns:
    true if the group include in record
  - setIncludeInRecord
```
public void setIncludeInRecord(boolean includeInRecord)
```
    Sets whether or not the group include in record
    
    Parameters:
    includeInRecord -
  - isCatchAll
```
public boolean isCatchAll()
```
    Returns:
    true if this is a "catch all" group
  - setCatchAll
```
public void setCatchAll(boolean isCatchAll)
```
    Sets whether or not this is a catch-all group
    
    Parameters:
    isCatchAll -
  - setAttributeKeys
```
public void setAttributeKeys(java.util.List<java.lang.String> attributeKeys)
```
    Parameters:
    attributeKeys - the attributeKeys to set
  - getAttributeKeys
```
public java.util.List<java.lang.String> getAttributeKeys()
```
    Returns:
    the attributeKeys
  - formGeneralGroupKey
```
public static java.lang.String formGeneralGroupKey(java.lang.String viewKey)
```
    Forms the group key to be used for a view's "General" attribute group. Use this when creating a new/default General attribute group to distinguish with other views' general groups.
    
    Parameters:
    viewKey - a base or semantic view key
  - formGroupKey
```
public static java.lang.String formGroupKey(java.lang.String viewKey,
                            java.lang.String groupKey)
```
    Forms a group key based on the specified view key. Use this when creating new/default attribute groups to distinguish with other views' groups that might have the same key.
    
    Parameters:
    viewKey - a base or semantic view key
  - getOriginGroupKey
```
public java.lang.String getOriginGroupKey(java.lang.String viewKey)
```
    Gets the origin group key without the viewKey prefix.
    
    Parameters:
    viewKey - a base or semantic view key
  - clone
```
public Group clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class Group

Field Summary

Fields inherited from class com.endeca.portal.attributes.model.BasePropertyContainer

Constructor Summary

Method Summary

Methods inherited from class com.endeca.portal.attributes.model.BasePropertyContainer

Methods inherited from class java.lang.Object

Field Detail

DISPLAY_NAME_PROPERTY

LOCALIZED_DISPLAY_NAME_PROPERTY

ATTRIBUTE_KEYS_PROPERTY

IS_DYNAMIC_PROPERTY

SORT_PROPERTY

INCLUDE_IN_NAVIGATION_PROPERTY

INCLUDE_IN_RECORD_PROPERTY

IS_CATCHALL_PROPERTY

RECORD_IDENTIFIER_GROUP_KEY

DETAILS_GROUP_KEY

GENERAL_GROUP_KEY

GEOSPATIAL_GROUP_KEY

DEFAULT_HIDDEN_NAV_GROUPS

DEFAULT_HIDDEN_REC_DTL_GROUPS

Constructor Detail

Group

Method Detail

setDisplayName

getDisplayName

getDisplayName

getDisplayName

getDisplayName

setLocalizedDisplayName

getLocalizedDisplayName

isDynamic

setDynamic

setSort

getSort

isIncludeInNavigation

setIncludeInNavigation

isIncludeInRecord

setIncludeInRecord

isCatchAll

setCatchAll

setAttributeKeys

getAttributeKeys

formGeneralGroupKey

formGroupKey

getOriginGroupKey

clone