public class URLParameterToNounElementAssociation
extends java.lang.Object
Modifier | Constructor and Description |
---|---|
protected | URLParameterToNounElementAssociation()
Creates an instance of the URL parameter to noun element configuration.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map | getAssociatedUrlParameters()
This method returns the map that contains the url parameters that are associated to this URL parameter.
|
java.lang.String[] | getNameAttribute()
This method returns the name attribute where the user data name of the user data type is located.
|
java.lang.String[] | getNounElementTree()
This method returns the tree of elements of the current association.
|
java.lang.String | getType()
This method returns the declared type of the association.
|
java.lang.String | getURLParameterName()
This method returns the URL parameter name of the association.
|
java.lang.String[] | getValueAttribute()
This method returns the value attribute where the user data value of the user data type is located.
|
java.lang.String | getXPath()
This method returns the specified XPath of the noun defined in the association.
|
protected void | init(org.w3c.dom.Element configurationElement, URLClientObjectToNounAssociation urlObjectToNoun)
Initializes an instance of the URL parameter to noun element configuration.
|
boolean | isEmptyValueAllowed()
This method returns whether the the value is allowed to be empty when the URL parameter is mapped to the noun.
|
boolean | isKeyElement()
This method returns whether the current property is considered one of the unique properties of the business object.
|
boolean | isModifiable()
This method returns whether the current element is modifiable when building the Change business object document.
|
boolean | isNillable()
This method returns whether the value is allowed to be null when the URL parameter is mapped to the noun.
|
boolean | isPreservingDataType()
This method returns whether the value should be kept in its native data type form.
|
boolean | isReturnedElement()
This method returns whether the current property should be returned when the transformation from noun to URL parameter is being performed.
|
java.lang.String | toString()
This method returns the string representation of the object for debugging purposes.
|
protected URLParameterToNounElementAssociation()
protected void init(org.w3c.dom.Element configurationElement, URLClientObjectToNounAssociation urlObjectToNoun)
public java.lang.String toString()
public boolean isKeyElement()
public boolean isModifiable()
public boolean isReturnedElement()
public boolean isEmptyValueAllowed()
public boolean isNillable()
public boolean isPreservingDataType()
public java.lang.String[] getNounElementTree()
public java.lang.String getType()
public java.lang.String getURLParameterName()
public java.lang.String getXPath()
public java.lang.String[] getNameAttribute()
public java.lang.String[] getValueAttribute()
public java.util.Map getAssociatedUrlParameters()
<_config:URLParameter name="PROPERTY_" nounElement="/CampaignElement/CampaignElementVariable" type="UserData" > <_config:ParameterAssociation name="ASSOCIATEDPROPERTY_sequence_" value="/SequenceOrder" /> </_config:URLParameter>The request has the following parameters:
PROPERTY_catalogEntryIdList=[10251, 10253, 10255] ASSOCIATEDPROPERTY_sequence_catalogEntryIdList=[1.0, 3.0, 2.0]For each PROPERTY_ parameter an associated parameter will be looked for in the request. The associated parameter will begin with the prefix specified in the ParameterAssociation name. If the associated parameter is found in the request, then the value of the parameter will be put in the noun in the location specified in the ParameterAssociation value. For the previous example, the noun will look like the following:
<_mkt:CampaignElementVariable> <_mkt:Name>catalogEntryIdList</_mkt:Name> <_mkt:Value>10251</_mkt:Value> <_mkt:SequenceOrder>1.0</_mkt:SequenceOrder> </_mkt:CampaignElementVariable> <_mkt:CampaignElementVariable> <_mkt:Name>catalogEntryIdList</_mkt:Name> <_mkt:Value>10253</_mkt:Value> <_mkt:SequenceOrder>3.0</_mkt:SequenceOrder> </_mkt:CampaignElementVariable> <_mkt:CampaignElementVariable> <_mkt:Name>catalogEntryIdList</_mkt:Name> <_mkt:Value>10255</_mkt:Value> <_mkt:SequenceOrder>2.0</_mkt:SequenceOrder> </_mkt:CampaignElementVariable>Multiple ParameterAssociations can be specified for the same URLParameter.