Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://django-river.readthedocs.io/en/latest/api/instance.html below:

Instance API — django-river 3.2.0 documentation

This page will be covering the instance level API. It is all the function that you can access through your model object like in the example below;

my_model=MyModel.objects.get(....)

my_model.river.my_state_field.<function>(*args)

This is the function that helps you to approve next approval of the object easily. django-river will handle all the availability and the authorization issues.

>>> my_model.river.my_state_field.approve(as_user=team_leader)
>>> my_model.river.my_state_field.approve(as_user=team_leader, next_state=State.objects.get(name='re_opened_state'))

A user to make the transaction.

django-river will check

if this user is authorized to

make next action by looking at

this user’s permissions and

user groups.

This parameter is redundant

as long as there is only one

next state from the current

state. But if there is multiple

possible next state in place,

django-river is naturally

is unable know which one is

actually supposed to be picked.

If the given next state is not

a valid next state a RiverException

will be thrown.

This is the function that helps you to fetch all available approvals waiting for a spesific user according to given source and destination states. If the source state is not provided, django-river will pick the current objects source state.

>>> transition_approvals = my_model.river.my_state_field.get_available_approvals(as_user=manager)
>>> transition_approvals = my_model.river.my_state_field.get_available_approvals(as_user=manager, source_state=State.objects.get(name='in_progress'))
>>> transition_approvals = my_model.river.my_state_field.get_available_approvals(
        as_user=manager,
        source_state=State.objects.get(name='in_progress'),
        destination_state=State.objects.get(name='resolved'),
    )

A user to find all the approvals

by user’s permissions and groups

Current

Object’s

Source State

A base state to find all available

approvals comes after. Default is

current object’s source state

A spesific destination state to

fetch all available state. If it

is not provided, the approvals

will be found for all available

destination states

List of available transition approvals

This is a property that the transition approval which has recently been approved for the model object.

>>> transition_approval = my_model.river.my_state_field.last_approval

Last approved transition approval

for the model object

This is a property that the list of transition approvals as a next step.

>>> transition_approvals == my_model.river.my_state_field.next_approvals
True

List of transition approvals comes

after last approved transition

approval

This is a property that indicates if object is on initial state.

>>> my_model.river.my_state_field.on_initial_state
True

This is a property that indicates if object is on final state.

>>> my_model.river.my_state_field.on_final_state
True

True if object is on final state

which also means that the workflow

is complete

This is the function that allows to jump to a specific future state from the current state of the workflow object. It is good for testing purposes.

>>> in_progress_state = State.object.get(label="In Progress")
>>> transition_approvals = my_model.river.my_state_field.jump_to(in_progress_state)

The target state that the workflow

object will jump to. It is supposed

to be a possible state in the future

of the workflow object

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4