setBasketColumnProperties
void setBasketColumnProperties(SessionId sessionId, BasketColumn[] columns)
throws BasketServiceFault;
See also: SessionId, BasketColumn, BasketServiceFault
Set properties of zero or more columns of the specified session’s basket.
The id attribute of each column must be a properly formatted UUID and must identify an existing column.
The type attribute, if specified, must not be Undefined or Builtin.
The itemAttrId attribute, if specified, must be UserDefined.
The defaultColumn attribute, if specified and non-empty, must be a properly formatted UUID and either identify an existing column or be the NIL UUID.
Note that a specified, but empty, defaultColumn attribute is not interpreted as the NIL UUID. To reset the default column, an actual NIL UUID must be specified.
The name and title elements, if present, must be non-empty.
It is an error if the defaultColumn attribute contains an UUID other than the NIL UUID, and the defaultValue element contains a non-empty string.
The implementation of this operation attempts to make sure, but cannot guarantee, that no change to the column configuration took place in case of an abnormal termination.
Columns are modified, one after another, in the order specified by parameter columns. For each column, properties are modified as follows, in the given order:
-
If the
typeattribute is specified, then the column type is set to the given value. -
If the
nameelement is present, the column name is set to its value. -
If the
titleelement is present, the column title is set to its value. -
If the
readOnlyattribute is specified, then the read-only property of the column is adjusted accordingly. -
If the
defaultColumnattribute is specified and non-empty, the default column of the current column is set accordingly. If the attribute contains the NIL UUID, then the default column will be reset. Otherwise, the default column is set to the column with the specified ID and the default value of the column, if any, is reset. -
If the
defaultValueelement is present (empty or not), the default value of the column will be set accordingly.
If any of these steps fails for whatever reason, the setBasketColumnProperties operation fails immediately. No configuration change done so far is undone.
The operation fails with a BasketServiceFault if
-
The session ID is not a properly formatted UUID.
-
The session ID does not reference an existing session.
-
For any of the error conditions described above.