URLClientObjectToNounAssociation

java.lang.Object
- com.ibm.commerce.foundation.client.facade.bod.servlet.config.URLClientObjectToNounAssociation

```
public class URLClientObjectToNounAssociation
extends java.lang.Object
```
This class represents the configuration that describes the transformation from a URL request to a business object document and vice versa. This configuration contains the mapping configuration between URL parameters and elements of the noun along with additional attributes of the elements.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM Copyright notice field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM Copyright notice field.

Constructor Summary

Constructors
Constructor and Description

URLClientObjectToNounAssociation()
Creates an instance of the URL to Noun association configuration.

Constructors
Constructor and Description
`URLClientObjectToNounAssociation()` Creates an instance of the URL to Noun association configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addUserDataPrefix(java.util.Set userDataPrefix)` This method sets The `UserData` prefix.
`java.util.List`	`getAssociations()` This method returns the list of associations that has been defined for the business object.
`java.util.List`	`getKeyProperty()` This method returns a list of properties of the business object that has been declared and the unique identifier.
`java.lang.String`	`getListName()` Returns the list name.
`java.lang.String`	`getNoun()` This method returns the name of the noun.
`java.util.Map`	`getRequestFlattenProperties()` This method returns the flatten version of the association properties.
`java.lang.String`	`getURLObject()` This method returns the name of the URL object.
`java.util.List`	`getURLObjectReference()` This method returns a list of reference business objects that are child objects of the current business object.
`org.w3c.dom.NamedNodeMap`	`getUrlParameterGroupAttributes()` This method returns a Map of the attributes associated with this URL parameter group.
`java.util.Set`	`getUserDataPrefix()` This method returns the naming prefix used to identify `UserData` elements.
`void`	`init(org.w3c.dom.Element configurationElement)` Initializes the instance of the URL to Noun association configuration.
`boolean`	`isFlattened()`
`void`	`setRequestFlattenProperties(java.util.Map flattenProperties)` This method sets the flatten properties of the object.
`java.lang.String`	`toString()` This method returns the string representation of the object for debugging purposes.

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

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - URLClientObjectToNounAssociation
```
public URLClientObjectToNounAssociation()
```
    Creates an instance of the URL to Noun association configuration. This constructor will populate itself by loading the specified configuration element.
- Method Detail
  - init
```
public void init(org.w3c.dom.Element configurationElement)
```
    Initializes the instance of the URL to Noun association configuration. This constructor will populate itself by loading the specified configuration element.
    
    Parameters:
    
    configurationElement - The configuration element that describes the association.
  - toString
```
public java.lang.String toString()
```
    This method returns the string representation of the object for debugging purposes.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The String representation of the object.
  - getAssociations
```
public java.util.List getAssociations()
```
    This method returns the list of associations that has been defined for the business object.
    
    Returns:
    
    A list of URL to Noun associations for the noun.
  - getKeyProperty
```
public java.util.List getKeyProperty()
```
    This method returns a list of properties of the business object that has been declared and the unique identifier.
    
    Returns:
    
    A list of business object properties that is considered to be the unique identifier of the business object.
  - getNoun
```
public java.lang.String getNoun()
```
    This method returns the name of the noun.
    
    Returns:
    
    The name of the noun.
  - getURLObject
```
public java.lang.String getURLObject()
```
    This method returns the name of the URL object.
    
    Returns:
    
    The name of the URL object.
  - getURLObjectReference
```
public java.util.List getURLObjectReference()
```
    This method returns a list of reference business objects that are child objects of the current business object.
    
    Returns:
    
    The list of child objects defined for the current business object.
  - getUserDataPrefix
```
public java.util.Set getUserDataPrefix()
```
    This method returns the naming prefix used to identify UserData elements.
    
    Returns:
    
    The UserData prefix.
  - getListName
```
public java.lang.String getListName()
```
    Returns the list name.
    
    Returns:
    
    The list name.
  - isFlattened
```
public boolean isFlattened()
```
    Returns:
    
    true if the BOD is flattened.
  - getUrlParameterGroupAttributes
```
public org.w3c.dom.NamedNodeMap getUrlParameterGroupAttributes()
```
    This method returns a Map of the attributes associated with this URL parameter group.
    
    Returns:
    
    A NamedNodeMap of URLParameterGroup attributes.
  - addUserDataPrefix
```
public void addUserDataPrefix(java.util.Set userDataPrefix)
```
    This method sets The UserData prefix.
    
    Parameters:
    
    userDataPrefix - The UserData prefix.
  - getRequestFlattenProperties
```
public java.util.Map getRequestFlattenProperties()
```
    This method returns the flatten version of the association properties.
    
    Returns:
    
    The flatten version of the properties.
  - setRequestFlattenProperties
```
public void setRequestFlattenProperties(java.util.Map flattenProperties)
```
    This method sets the flatten properties of the object.
    
    Parameters:
    
    flattenProperties - The flatten properties.

Methods inherited from class java.lang.Object

COPYRIGHT

URLClientObjectToNounAssociation

init

toString

getAssociations

getKeyProperty

getNoun

getURLObject

getURLObjectReference

getUserDataPrefix

getListName

isFlattened

getUrlParameterGroupAttributes

addUserDataPrefix

getRequestFlattenProperties

setRequestFlattenProperties