Package bscw :: Package api :: Package Tasks :: Module ap_editwbtask
[hide private]

Module ap_editwbtask

API to edit a task.

API definition:

API = (('task_id', 'ASCII string', 1),
       ('contractors', 'array', 0, [('user_name', 'ASCII string', 1)]),
       ('renamings', 'array', 0, [('name_pair', 'array', 1, [('name', 'Unicode string', 0)])]),
       ('new_input', 'array', 0, [('datafield', 'struct', 1, [('name', 'Unicode string', 1),
       ('alternative', 'Unicode string', 0),
       ('obligation', 'int', 0),
       ('transparent', 'boolean', 0)])]),
       ('new_output', 'array', 0, [('datafield', 'struct', 1, [('name', 'Unicode string', 1),
       ('alternative', 'Unicode string', 0),
       ('obligation', 'int', 0),
       ('transparent', 'boolean', 0)])]),
       ('new_pp_input', 'array', 0, [('datafield', 'struct', 1, [('name', 'Unicode string', 1),
       ('alternative', 'Unicode string', 0),
       ('obligation', 'int', 0),
       ('transparent', 'boolean', 0)])]),
       ('new_pp_output', 'array', 0, [('datafield', 'struct', 1, [('name', 'Unicode string', 1),
       ('alternative', 'Unicode string', 0),
       ('obligation', 'int', 0),
       ('transparent', 'boolean', 0)])]),
       ('duration', 'int', 0),
       ('alarms', 'array', 0, [('alarm', 'struct', 1, [('index', 'int', 0),
       ('time', 'int', 0),
       ('userids', 'array', 0, [('entry', 'int', 1)]),
       ('text', 'Unicode string', 0)])]),
       ('notifications', 'array', 0, [('entry', 'int', 1)]))

(c) Orbiteam Software GmbH & Co KG, 2007


Version: $Rev: 20268 $

Functions [hide private]
 
param_def()
Return the parameter definition.
 
do_it(request, task_id, contractors=[], renamings=[], new_input=[], new_output=[], new_pp_input=[], new_pp_output=[], duration=None, alarms=[], notifications=[])
See above.
 
edit_task(request, task, contractors, rename_pairs, new_input, new_output, existing_input, existing_output, duration, alarms, notifications)
Edit (change) task (for user requests).
 
edit_alarms(request, task, alarms, set_event=True)
Edit (change) task alarms (email reminders).
 
edit_notifications(request, task, notifications, set_event=True)
Edit (change) task notifications (email notifications).
 
edit_fields(request, task, rename_pairs=(), new_input=(), new_output=(), existing_input=None, existing_output=None)
Edit (change) task fields (for user requests).
 
rename_field(request, task, oldname, newname, touchf=None)
 
_add_field(task, df, request, iotype=0)
 
_change_existing_fields(task, existing_fields, touch, request, iotype)
 
_edit_field(task, df, request, iotype=0)
Variables [hide private]
  __package__ = 'bscw.api.Tasks'
Function Details [hide private]

edit_task(request, task, contractors, rename_pairs, new_input, new_output, existing_input, existing_output, duration, alarms, notifications)

 
Edit (change) task (for user requests).

Arguments:
request: current request
task: task to be edited
contractors: changed list of contractors
rename_pairs, new_input, new_output, existing_input, existing_output:
  see method edit_fields
duration: changed duration
alarms: changed/new/deletable alarms (see bs_wbtaskapi for details)

edit_alarms(request, task, alarms, set_event=True)

 

Edit (change) task alarms (email reminders).

Arguments: request: current request task: task to be edited alarms: list of alarm structs (see bs_wbtaskapi for details)

Returns True if event has been set.

edit_notifications(request, task, notifications, set_event=True)

 

Edit (change) task notifications (email notifications).

Arguments: request: current request task: task to be edited notifications: list of NE_... (see cl_wbtask.WBTask for details)

Returns True if event has been set.

edit_fields(request, task, rename_pairs=(), new_input=(), new_output=(), existing_input=None, existing_output=None)

 
Edit (change) task fields (for user requests).

Arguments:
request: current request
task: task to be edited
rename_pairs: list of (old field name, changed field name) pairs;
    note that existing fields are deleted when changed field name is ''.
new_input: list of new input field names
new_output: list of new output field names
existing_input: list of existing field names which should be our input
    and are either parent-, peer- or sub fields; note that all fields
    from parent not listed in existing_input are deleted from task. If
    you wish to keep the fields unchanged, use existing_input = None.
existing_output: as existing_input, but field names should be our output.

Returns True if event has been set.