ForeignKey (BroadleafCommerce Open Admin Platform 6.2.8-GA API)

java.lang.Object
- org.broadleafcommerce.openadmin.dto.ForeignKey

All Implemented Interfaces:

Serializable, PersistencePerspectiveItem
```
public class ForeignKey
extends Object
implements Serializable, PersistencePerspectiveItem
```
Author:

jfischer

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ForeignKey()`
`ForeignKey(String manyToField, String foreignKeyClass)`
`ForeignKey(String manyToField, String foreignKeyClass, String dataSourceName)`
`ForeignKey(String manyToField, String foreignKeyClass, String dataSourceName, ForeignKeyRestrictionType restrictionType)`
`ForeignKey(String manyToField, String foreignKeyClass, String dataSourceName, ForeignKeyRestrictionType restrictionType, String displayValueProperty)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(PersistencePerspectiveItemVisitor visitor)`
`ForeignKey`	`cloneForeignKey()`
`PersistencePerspectiveItem`	`clonePersistencePerspectiveItem()`
`boolean`	`equals(Object o)`
`String`	`getCurrentValue()`
`String`	`getDataSourceName()`
`String`	`getDisplayValueProperty()`
`String`	`getForeignKeyClass()`
`String`	`getManyToField()`
`Boolean`	`getMutable()`
`String`	`getOriginatingField()`
`ForeignKeyRestrictionType`	`getRestrictionType()`
`Boolean`	`getSortAscending()`
`String`	`getSortField()`
`int`	`hashCode()`
`void`	`setCurrentValue(String currentValue)`
`void`	`setDataSourceName(String dataSourceName)`
`void`	`setDisplayValueProperty(String displayValueProperty)`
`void`	`setForeignKeyClass(String foreignKeyClass)`
`void`	`setManyToField(String manyToField)`
`void`	`setMutable(Boolean mutable)`
`void`	`setOriginatingField(String originatingField)`
`void`	`setRestrictionType(ForeignKeyRestrictionType restrictionType)`
`void`	`setSortAscending(Boolean sortAscending)`
`void`	`setSortField(String sortField)`
`String`	`toString()`
`ForeignKey`	`withForeignKeyClass(String foreignKeyClass)`
`ForeignKey`	`withManyToField(String manyToField)`
`ForeignKey`	`withOriginatingField(String originatingField)`
`ForeignKey`	`withSortField(String sortField)`

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

Constructor Detail

ForeignKey
```
public ForeignKey()
```

ForeignKey

public ForeignKey(String manyToField,
                  String foreignKeyClass)

ForeignKey

public ForeignKey(String manyToField,
                  String foreignKeyClass,
                  String dataSourceName)

ForeignKey

public ForeignKey(String manyToField,
                  String foreignKeyClass,
                  String dataSourceName,
                  ForeignKeyRestrictionType restrictionType)

ForeignKey

public ForeignKey(String manyToField,
                  String foreignKeyClass,
                  String dataSourceName,
                  ForeignKeyRestrictionType restrictionType,
                  String displayValueProperty)

Method Detail

withManyToField

public ForeignKey withManyToField(String manyToField)

withOriginatingField

public ForeignKey withOriginatingField(String originatingField)

withForeignKeyClass

public ForeignKey withForeignKeyClass(String foreignKeyClass)

withSortField

public ForeignKey withSortField(String sortField)

getManyToField
```
public String getManyToField()
```

setManyToField

public void setManyToField(String manyToField)

getForeignKeyClass
```
public String getForeignKeyClass()
```

setForeignKeyClass

public void setForeignKeyClass(String foreignKeyClass)

getCurrentValue
```
public String getCurrentValue()
```

setCurrentValue

public void setCurrentValue(String currentValue)

getDataSourceName
```
public String getDataSourceName()
```

setDataSourceName

public void setDataSourceName(String dataSourceName)

getRestrictionType

public ForeignKeyRestrictionType getRestrictionType()

setRestrictionType

public void setRestrictionType(ForeignKeyRestrictionType restrictionType)

getDisplayValueProperty

public String getDisplayValueProperty()

setDisplayValueProperty

public void setDisplayValueProperty(String displayValueProperty)

getSortField
```
public String getSortField()
```

setSortField

public void setSortField(String sortField)

getSortAscending
```
public Boolean getSortAscending()
```

setSortAscending

public void setSortAscending(Boolean sortAscending)

getMutable
```
public Boolean getMutable()
```

setMutable

public void setMutable(Boolean mutable)

getOriginatingField
```
public String getOriginatingField()
```

setOriginatingField

public void setOriginatingField(String originatingField)

accept

public void accept(PersistencePerspectiveItemVisitor visitor)

Specified by:: accept in interface PersistencePerspectiveItem

toString
```
public String toString()
```
Overrides:

toString in class Object

cloneForeignKey
```
public ForeignKey cloneForeignKey()
```

clonePersistencePerspectiveItem
```
public PersistencePerspectiveItem clonePersistencePerspectiveItem()
```
Specified by:

clonePersistencePerspectiveItem in interface PersistencePerspectiveItem

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class ForeignKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForeignKey

ForeignKey

ForeignKey

ForeignKey

ForeignKey

Method Detail

withManyToField

withOriginatingField

withForeignKeyClass

withSortField

getManyToField

setManyToField

getForeignKeyClass

setForeignKeyClass

getCurrentValue

setCurrentValue

getDataSourceName

setDataSourceName

getRestrictionType

setRestrictionType

getDisplayValueProperty

setDisplayValueProperty

getSortField

setSortField

getSortAscending

setSortAscending

getMutable

setMutable

getOriginatingField

setOriginatingField

accept

toString

cloneForeignKey

clonePersistencePerspectiveItem

equals

hashCode