|
object-field.create
|
| |
|
description
Create field (also called object definition) inside an object.
privilege-required
administrator
tx-support
true
|
| |
|
INSTRUCTION
|
|
name
|
type
|
default-value
|
required
|
description
|
| object-name |
string |
none |
true |
Concerned object name. |
|
| |
|
PARAMETER
|
|
name
|
type
|
default-value
|
required
|
description
|
| mandatory |
boolean |
none |
true |
Tell if the field is mandatory to instanciate the whole object class. |
| policy-modify |
string |
none |
true |
Requiered right to modify the field value. |
| indexed |
boolean |
none |
true |
Tell if the field content should be indexed by the search engine. |
| type |
string |
none |
true |
Field type (known fields are:
boolean,
date,
float,
integer,
redirection,
redirection-publish,
string).
|
| name |
string |
none |
true |
Field name (should respect regexp defined in confuration file). |
| policy-create |
string |
none |
true |
Requiered right to instanciate the field value. |
| max-versions |
integer |
1 |
false |
|
| minimum |
Depends on type |
none |
false |
Minimum value (for numbers) or size (for strings). Parameter type depends on the type of the object field.
Boolean and redirection do not need minimum. |
| maximum |
Depends on type |
none |
false |
Maximum value (for numbers) or size (for strings). Parameter type depends on the type of the object field.
Boolean and redirection do not need maximum. |
|
| |
|
ERROR
|
|
|
id
|
msg
|
| 1 |
Unknown policy |
| 2 |
Unknown object name |
| 3 |
Object definition name allready exists |
| 4 |
Maximum and minimum required |
| 5 |
Maximum lower than minimum |
| 6 |
Maximum or minimum value must be positive for text content |
| 7 |
Maximum string size reached |
|
| |
|
RESULT
|
|
|
name
|
description
|
| id |
Id of the new field. |
|
| |
|
EXAMPLE
|
|
|
example 1
|
<nvd:command name="object-field.create" object-name="news">
<nvd:parameter name="name">title</nvd:parameter>
<nvd:parameter name="type">string</nvd:parameter>
<nvd:parameter name="minimum" type="integer">0</nvd:parameter>
<nvd:parameter name="maximum" type="integer">1025</nvd:parameter>
<nvd:parameter name="policy-create">editor</nvd:parameter>
<nvd:parameter name="policy-modify">administrator</nvd:parameter>
<nvd:parameter name="mandatory">true</nvd:parameter>
<nvd:parameter name="indexed">false</nvd:parameter>
<nvd:result name="id" variable="objectdef-id" />
</nvd:command>
|
|
