ListAttribute (Salesforce Marketing Cloud Java SDK 1.2.1 API)

java.lang.Object
- com.exacttarget.fuelsdk.internal.APIObject
- - com.exacttarget.fuelsdk.internal.ListAttribute

public class ListAttribute
extends APIObject

Java class for ListAttribute complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ListAttribute">
   <complexContent>
     <extension base="{http://exacttarget.com/wsdl/partnerAPI}APIObject">
       <sequence>
         <element name="List" type="{http://exacttarget.com/wsdl/partnerAPI}List" minOccurs="0"/>
         <element name="Name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="FieldType" type="{http://exacttarget.com/wsdl/partnerAPI}ListAttributeFieldType" minOccurs="0"/>
         <element name="FieldLength" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="Scale" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="MinValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="MaxValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="DefaultValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="IsNullable" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="IsHidden" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="IsReadOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="Inheritable" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="Overridable" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="MustOverride" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="OverrideType" type="{http://exacttarget.com/wsdl/partnerAPI}OverrideType" minOccurs="0"/>
         <element name="Ordinal" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="RestrictedValues" type="{http://exacttarget.com/wsdl/partnerAPI}ListAttributeRestrictedValue" maxOccurs="unbounded" minOccurs="0"/>
         <element name="BaseAttribute" type="{http://exacttarget.com/wsdl/partnerAPI}ListAttribute" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected ListAttribute`	`baseAttribute`
`protected String`	`defaultValue`
`protected String`	`description`
`protected Integer`	`fieldLength`
`protected ListAttributeFieldType`	`fieldType`
`protected Boolean`	`inheritable`
`protected Boolean`	`isHidden`
`protected Boolean`	`isNullable`
`protected Boolean`	`isReadOnly`
`protected List`	`list`
`protected String`	`maxValue`
`protected String`	`minValue`
`protected Boolean`	`mustOverride`
`protected String`	`name`
`protected Integer`	`ordinal`
`protected Boolean`	`overridable`
`protected OverrideType`	`overrideType`
`protected List<ListAttributeRestrictedValue>`	`restrictedValues`
`protected Integer`	`scale`

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject
client, correlationID, createdDate, customerKey, id, modifiedDate, objectID, objectState, owner, partnerKey, partnerProperties

Constructor Summary

Constructors
Constructor and Description

ListAttribute()

Constructors
Constructor and Description
`ListAttribute()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListAttribute`	`getBaseAttribute()` Gets the value of the baseAttribute property.
`String`	`getDefaultValue()` Gets the value of the defaultValue property.
`String`	`getDescription()` Gets the value of the description property.
`Integer`	`getFieldLength()` Gets the value of the fieldLength property.
`ListAttributeFieldType`	`getFieldType()` Gets the value of the fieldType property.
`Boolean`	`getInheritable()` Gets the value of the inheritable property.
`Boolean`	`getIsHidden()` Gets the value of the isHidden property.
`Boolean`	`getIsNullable()` Gets the value of the isNullable property.
`Boolean`	`getIsReadOnly()` Gets the value of the isReadOnly property.
`List`	`getList()` Gets the value of the list property.
`String`	`getMaxValue()` Gets the value of the maxValue property.
`String`	`getMinValue()` Gets the value of the minValue property.
`Boolean`	`getMustOverride()` Gets the value of the mustOverride property.
`String`	`getName()` Gets the value of the name property.
`Integer`	`getOrdinal()` Gets the value of the ordinal property.
`Boolean`	`getOverridable()` Gets the value of the overridable property.
`OverrideType`	`getOverrideType()` Gets the value of the overrideType property.
`List<ListAttributeRestrictedValue>`	`getRestrictedValues()` Gets the value of the restrictedValues property.
`Integer`	`getScale()` Gets the value of the scale property.
`void`	`setBaseAttribute(ListAttribute value)` Sets the value of the baseAttribute property.
`void`	`setDefaultValue(String value)` Sets the value of the defaultValue property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setFieldLength(Integer value)` Sets the value of the fieldLength property.
`void`	`setFieldType(ListAttributeFieldType value)` Sets the value of the fieldType property.
`void`	`setInheritable(Boolean value)` Sets the value of the inheritable property.
`void`	`setIsHidden(Boolean value)` Sets the value of the isHidden property.
`void`	`setIsNullable(Boolean value)` Sets the value of the isNullable property.
`void`	`setIsReadOnly(Boolean value)` Sets the value of the isReadOnly property.
`void`	`setList(List value)` Sets the value of the list property.
`void`	`setMaxValue(String value)` Sets the value of the maxValue property.
`void`	`setMinValue(String value)` Sets the value of the minValue property.
`void`	`setMustOverride(Boolean value)` Sets the value of the mustOverride property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setOrdinal(Integer value)` Sets the value of the ordinal property.
`void`	`setOverridable(Boolean value)` Sets the value of the overridable property.
`void`	`setOverrideType(OverrideType value)` Sets the value of the overrideType property.
`void`	`setScale(Integer value)` Sets the value of the scale property.
`String`	`toString()` Generates a String representation of the contents of this type.

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject
getClient, getCorrelationID, getCreatedDate, getCustomerKey, getId, getModifiedDate, getObjectID, getObjectState, getOwner, getPartnerKey, getPartnerProperties, setClient, setCorrelationID, setCreatedDate, setCustomerKey, setId, setModifiedDate, setObjectID, setObjectState, setOwner, setPartnerKey

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

- Field Detail
  - list
```
protected List list
```
  - name
```
protected String name
```
  - description
```
protected String description
```
  - fieldType
```
protected ListAttributeFieldType fieldType
```
  - fieldLength
```
protected Integer fieldLength
```
  - scale
```
protected Integer scale
```
  - minValue
```
protected String minValue
```
  - maxValue
```
protected String maxValue
```
  - defaultValue
```
protected String defaultValue
```
  - isNullable
```
protected Boolean isNullable
```
  - isHidden
```
protected Boolean isHidden
```
  - isReadOnly
```
protected Boolean isReadOnly
```
  - inheritable
```
protected Boolean inheritable
```
  - overridable
```
protected Boolean overridable
```
  - mustOverride
```
protected Boolean mustOverride
```
  - overrideType
```
protected OverrideType overrideType
```
  - ordinal
```
protected Integer ordinal
```
  - restrictedValues
```
protected List<ListAttributeRestrictedValue> restrictedValues
```
  - baseAttribute
```
protected ListAttribute baseAttribute
```
- Constructor Detail
  - ListAttribute
```
public ListAttribute()
```
- Method Detail
  - getList
```
public List getList()
```
    Gets the value of the list property.
    
    Returns:
    
    possible object is List
  - setList
```
public void setList(List value)
```
    Sets the value of the list property.
    
    Parameters:
    
    value - allowed object is List
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getFieldType
```
public ListAttributeFieldType getFieldType()
```
    Gets the value of the fieldType property.
    
    Returns:
    
    possible object is ListAttributeFieldType
  - setFieldType
```
public void setFieldType(ListAttributeFieldType value)
```
    Sets the value of the fieldType property.
    
    Parameters:
    
    value - allowed object is ListAttributeFieldType
  - getFieldLength
```
public Integer getFieldLength()
```
    Gets the value of the fieldLength property.
    
    Returns:
    
    possible object is Integer
  - setFieldLength
```
public void setFieldLength(Integer value)
```
    Sets the value of the fieldLength property.
    
    Parameters:
    
    value - allowed object is Integer
  - getScale
```
public Integer getScale()
```
    Gets the value of the scale property.
    
    Returns:
    
    possible object is Integer
  - setScale
```
public void setScale(Integer value)
```
    Sets the value of the scale property.
    
    Parameters:
    
    value - allowed object is Integer
  - getMinValue
```
public String getMinValue()
```
    Gets the value of the minValue property.
    
    Returns:
    
    possible object is String
  - setMinValue
```
public void setMinValue(String value)
```
    Sets the value of the minValue property.
    
    Parameters:
    
    value - allowed object is String
  - getMaxValue
```
public String getMaxValue()
```
    Gets the value of the maxValue property.
    
    Returns:
    
    possible object is String
  - setMaxValue
```
public void setMaxValue(String value)
```
    Sets the value of the maxValue property.
    
    Parameters:
    
    value - allowed object is String
  - getDefaultValue
```
public String getDefaultValue()
```
    Gets the value of the defaultValue property.
    
    Returns:
    
    possible object is String
  - setDefaultValue
```
public void setDefaultValue(String value)
```
    Sets the value of the defaultValue property.
    
    Parameters:
    
    value - allowed object is String
  - getIsNullable
```
public Boolean getIsNullable()
```
    Gets the value of the isNullable property.
    
    Returns:
    
    possible object is Boolean
  - setIsNullable
```
public void setIsNullable(Boolean value)
```
    Sets the value of the isNullable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getIsHidden
```
public Boolean getIsHidden()
```
    Gets the value of the isHidden property.
    
    Returns:
    
    possible object is Boolean
  - setIsHidden
```
public void setIsHidden(Boolean value)
```
    Sets the value of the isHidden property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getIsReadOnly
```
public Boolean getIsReadOnly()
```
    Gets the value of the isReadOnly property.
    
    Returns:
    
    possible object is Boolean
  - setIsReadOnly
```
public void setIsReadOnly(Boolean value)
```
    Sets the value of the isReadOnly property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getInheritable
```
public Boolean getInheritable()
```
    Gets the value of the inheritable property.
    
    Returns:
    
    possible object is Boolean
  - setInheritable
```
public void setInheritable(Boolean value)
```
    Sets the value of the inheritable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getOverridable
```
public Boolean getOverridable()
```
    Gets the value of the overridable property.
    
    Returns:
    
    possible object is Boolean
  - setOverridable
```
public void setOverridable(Boolean value)
```
    Sets the value of the overridable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getMustOverride
```
public Boolean getMustOverride()
```
    Gets the value of the mustOverride property.
    
    Returns:
    
    possible object is Boolean
  - setMustOverride
```
public void setMustOverride(Boolean value)
```
    Sets the value of the mustOverride property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getOverrideType
```
public OverrideType getOverrideType()
```
    Gets the value of the overrideType property.
    
    Returns:
    
    possible object is OverrideType
  - setOverrideType
```
public void setOverrideType(OverrideType value)
```
    Sets the value of the overrideType property.
    
    Parameters:
    
    value - allowed object is OverrideType
  - getOrdinal
```
public Integer getOrdinal()
```
    Gets the value of the ordinal property.
    
    Returns:
    
    possible object is Integer
  - setOrdinal
```
public void setOrdinal(Integer value)
```
    Sets the value of the ordinal property.
    
    Parameters:
    
    value - allowed object is Integer
  - getRestrictedValues
```
public List<ListAttributeRestrictedValue> getRestrictedValues()
```
    Gets the value of the restrictedValues property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the restrictedValues property.
    For example, to add a new item, do as follows:
```
    getRestrictedValues().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ListAttributeRestrictedValue
  - getBaseAttribute
```
public ListAttribute getBaseAttribute()
```
    Gets the value of the baseAttribute property.
    
    Returns:
    
    possible object is ListAttribute
  - setBaseAttribute
```
public void setBaseAttribute(ListAttribute value)
```
    Sets the value of the baseAttribute property.
    
    Parameters:
    
    value - allowed object is ListAttribute
  - toString
```
public String toString()
```
    Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin
    
    Overrides:
    
    toString in class APIObject

Class ListAttribute

Field Summary

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject

Constructor Summary

Method Summary

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject

Methods inherited from class java.lang.Object

Field Detail

list

name

description

fieldType

fieldLength

scale

minValue

maxValue

defaultValue

isNullable

isHidden

isReadOnly

inheritable

overridable

mustOverride

overrideType

ordinal

restrictedValues

baseAttribute

Constructor Detail

ListAttribute

Method Detail

getList

setList

getName

setName

getDescription

setDescription

getFieldType

setFieldType

getFieldLength

setFieldLength

getScale

setScale

getMinValue

setMinValue

getMaxValue

setMaxValue

getDefaultValue

setDefaultValue

getIsNullable

setIsNullable

getIsHidden

setIsHidden

getIsReadOnly

setIsReadOnly

getInheritable

setInheritable

getOverridable

setOverridable

getMustOverride

setMustOverride

getOverrideType

setOverrideType

getOrdinal

setOrdinal

getRestrictedValues

getBaseAttribute

setBaseAttribute

toString