ListGridRecord (BroadleafCommerce Open Admin Platform 5.0.2-GA API)

java.lang.Object
- org.broadleafcommerce.openadmin.web.form.component.ListGridRecord

public class ListGridRecord
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`altId`
`protected String`	`displayOrder`
`protected String`	`errorKey`
`protected String`	`errorMessage`
`protected Map<String,Field>`	`fieldMap` Convenience map keyed by the field name.
`protected List<Field>`	`fields`
`protected List<Field>`	`hiddenFields`
`protected ListGridRecordIcon`	`icon`
`protected String`	`id`
`protected Boolean`	`isDirty`
`protected Boolean`	`isError`
`protected Boolean`	`isLocked`
`protected ListGrid`	`listGrid`

Constructor Summary

Constructors
Constructor and Description

ListGridRecord()

Constructors
Constructor and Description
`ListGridRecord()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearFieldMap()`
`String`	`getAltId()`
`boolean`	`getCanLinkToExternalEntity()`
`String`	`getDisplayOrder()`
`String`	`getErrorKey()`
`String`	`getErrorMessage()` Actual, localized error message.
`String`	`getExternalEntityPath()`
`Field`	`getField(String fieldName)` Returns a `Field` in this record for a particular field name.
`List<Field>`	`getFields()` Normally you should not be looping through these fields.
`Boolean`	`getHasIcon()`
`List<Field>`	`getHiddenFields()`
`String`	`getHiddenFieldsJson()`
`ListGridRecordIcon`	`getIcon()`
`String`	`getId()`
`int`	`getIndex()`
`Boolean`	`getIsDirty()`
`Boolean`	`getIsError()`
`ListGrid`	`getListGrid()`
`Boolean`	`getLocked()`
`String`	`getPath()`
`void`	`setAltId(String altId)`
`void`	`setDirty(Boolean isDirty)`
`void`	`setDisplayOrder(String displayOrder)`
`void`	`setErrorKey(String errorKey)`
`void`	`setErrorMessage(String errorMessage)` If set, this will override the errorKey.
`void`	`setFields(List<Field> fields)`
`void`	`setHiddenFields(List<Field> hiddenFields)`
`void`	`setIcon(ListGridRecordIcon icon)`
`void`	`setId(String id)`
`void`	`setIsError(Boolean isError)`
`void`	`setListGrid(ListGrid listGrid)`
`void`	`setLocked(Boolean locked)`

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

Field Detail

listGrid
```
protected ListGrid listGrid
```

id
```
protected String id
```

displayOrder
```
protected String displayOrder
```

altId
```
protected String altId
```

fields
```
protected List<Field> fields
```

hiddenFields
```
protected List<Field> hiddenFields
```

isDirty
```
protected Boolean isDirty
```

isError
```
protected Boolean isError
```

errorKey
```
protected String errorKey
```

errorMessage
```
protected String errorMessage
```

icon
```
protected ListGridRecordIcon icon
```

isLocked
```
protected Boolean isLocked
```

fieldMap
```
protected Map<String,Field> fieldMap
```
Convenience map keyed by the field name. Used to guarantee field ordering with header fields within a ListGrid

Constructor Detail
- ListGridRecord
```
public ListGridRecord()
```

Method Detail

getPath
```
public String getPath()
```

getCanLinkToExternalEntity

public boolean getCanLinkToExternalEntity()

getExternalEntityPath
```
public String getExternalEntityPath()
```

getListGrid
```
public ListGrid getListGrid()
```

setListGrid

public void setListGrid(ListGrid listGrid)

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getDisplayOrder
```
public String getDisplayOrder()
```

setDisplayOrder

public void setDisplayOrder(String displayOrder)

getIndex
```
public int getIndex()
```

getFields
```
public List<Field> getFields()
```
Normally you should not be looping through these fields. In order to preserve proper field ordering, instead you should loop through ListGrid.getHeaderFields() and then invoke the getField(String) method with that header field name.

Returns:

setFields

public void setFields(List<Field> fields)

getHiddenFields
```
public List<Field> getHiddenFields()
```

setHiddenFields

public void setHiddenFields(List<Field> hiddenFields)

getField
```
public Field getField(String fieldName)
```
Returns a Field in this record for a particular field name. Used when displaying a ListGrid in order to guarantee proper field ordering

Parameters:
fieldName -

Returns:

clearFieldMap
```
public void clearFieldMap()
```

getHiddenFieldsJson
```
public String getHiddenFieldsJson()
```

getIsDirty
```
public Boolean getIsDirty()
```

setDirty

public void setDirty(Boolean isDirty)

getIsError
```
public Boolean getIsError()
```

setIsError

public void setIsError(Boolean isError)

getErrorKey
```
public String getErrorKey()
```

setErrorKey

public void setErrorKey(String errorKey)

getErrorMessage
```
public String getErrorMessage()
```
Actual, localized error message. If set, this will override the error key.

Returns:

setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
If set, this will override the errorKey.

Parameters:
errorMessage -

getIcon
```
public ListGridRecordIcon getIcon()
```

setIcon

public void setIcon(ListGridRecordIcon icon)

getHasIcon
```
public Boolean getHasIcon()
```

getAltId
```
public String getAltId()
```

setAltId
```
public void setAltId(String altId)
```

getLocked
```
public Boolean getLocked()
```

setLocked

public void setLocked(Boolean locked)

Class ListGridRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

listGrid

id

displayOrder

altId

fields

hiddenFields

isDirty

isError

errorKey

errorMessage

icon

isLocked

fieldMap

Constructor Detail

ListGridRecord

Method Detail

getPath

getCanLinkToExternalEntity

getExternalEntityPath

getListGrid

setListGrid

getId

setId

getDisplayOrder

setDisplayOrder

getIndex

getFields

setFields

getHiddenFields

setHiddenFields

getField

clearFieldMap

getHiddenFieldsJson

getIsDirty

setDirty

getIsError

setIsError

getErrorKey

setErrorKey

getErrorMessage

setErrorMessage

getIcon

setIcon

getHasIcon

getAltId

setAltId

getLocked

setLocked