Package net.pricefx.formulaengine.scripting.queryapi.tables

Interface QapiActionItem

All Superinterfaces:
Map<String,SelectableExpression>, OutputsColumns, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiActionItem extends Tables.Table, PersistedObjectColumns, OutputsColumns
Table of Action Items, the actions that users are expected to perform, such as creating a quote or checking some prices.

Obtain it with api.queryApi().tables().actionItems(). Each row is one Action Item. Besides the columns below, the table offers the ID and audit columns of PersistedObjectColumns, the results of the Action Item logic through OutputsColumns.output(String), and the attribute fields that have a configured name, accessed as properties by that name.

To create or update Action Items from a logic, use api.actionItemApi() instead.

Example: 


 import net.pricefx.domain.ActionItem.ActionItemStatus

 def q = api.queryApi()
 def t = q.tables().actionItems()

 return q.source(t, [t.uniqueName(), t.summary(), t.assignedToName(), t.dueDate()],
         t.status().equal(ActionItemStatus.OPEN))
         .stream { it.collect { it } }
Since:
15.0.6 - Southside
See Also:

  • Method Details

    • summary

      SelectableExpression summary()
      Returns the short description of the required action.
      Returns:
      the summary column as a String representation
      See Also:

    • completedBy

      SelectableExpression completedBy()
      Returns the ID of the user who set the Action Item to DONE.
      Returns:
      the completedBy column as a Long representation
      See Also:

    • completedByName

      SelectableExpression completedByName()
      Returns the login name of the user who set the Action Item to DONE.
      Returns:
      the completedByName column as a String representation
      See Also:

    • completedDate

      SelectableExpression completedDate()
      Returns the date and time when the Action Item was set to DONE.
      Returns:
      the completedDate column as a DateTime representation
      See Also:

    • parentTypedId

      SelectableExpression parentTypedId()
      Returns the typed ID of the object the Action Item belongs to.

      The Action Item is shown on an Actions tab of this parent object.

      Returns:
      the parentTypedId column as a String representation
      See Also:

    • parentLabel

      SelectableExpression parentLabel()
      Returns the label of the parent object.
      Returns:
      the parentLabel column as a String representation
      See Also:

    • dueDatePassedNotificationSent

      SelectableExpression dueDatePassedNotificationSent()
      Returns the date and time when the notification that the due date passed was sent.

      The value is reset when the due date changes.

      Returns:
      the dueDatePassedNotificationSent column as a DateTime representation
      See Also:

    • parentTabName

      SelectableExpression parentTabName()
      Returns the name of the tab of the parent object on which the Action Item is shown.
      Returns:
      the parentTabName column as a String representation
      See Also:

    • originatorTypedId

      SelectableExpression originatorTypedId()
      Returns the typed ID of the object that caused the creation of the Action Item.
      Returns:
      the originatorTypedId column as a String representation
      See Also:

    • originatorLabel

      SelectableExpression originatorLabel()
      Returns the label of the object that caused the creation of the Action Item.
      Returns:
      the originatorLabel column as a String representation
      See Also:

    • actionItemTypeUniqueName

      SelectableExpression actionItemTypeUniqueName()
      Returns the unique name of the Action Item Type.
      Returns:
      the actionItemTypeUniqueName column as a String representation

    • status

      SelectableExpression status()
      Returns the status of the Action Item.

      The value is one of OPEN (the starting point), DONE (completed), REJECTED (the user decided not to do the action), BLOCKED (the work is blocked by something or someone) or POSTPONED (the work will resume later). DONE and REJECTED are final states.

      Example: 

      
 import net.pricefx.domain.ActionItem.ActionItemStatus

 def q = api.queryApi()
 def t = q.tables().actionItems()

 return q.source(t, [t.uniqueName(), t.summary(), t.status()], t.status().notEqual(ActionItemStatus.DONE))
         .stream { it.collect { it } }
      Returns:
      the status column as an Enum expression
      See Also:

    • createdByName

      SelectableExpression createdByName()
      Returns the name of the user who created the Action Item.
      Returns:
      the createdByName column as a String expression
      See Also:

    • lastUpdateByName

      SelectableExpression lastUpdateByName()
      Returns the name of the user who last updated the Action Item.
      Returns:
      the lastUpdateByName column as a String expression
      See Also:

    • assignedTo

      SelectableExpression assignedTo()
      Returns the ID of the user the Action Item is assigned to.
      Returns:
      the assignedTo column as a Long expression
      See Also:

    • assignedToName

      SelectableExpression assignedToName()
      Returns the name of the user the Action Item is assigned to.
      Returns:
      the assignedToName column as a String expression
      See Also:

    • assignedToGroup

      SelectableExpression assignedToGroup()
      Returns the user group the Action Item is assigned to.
      Returns:
      the assignedToGroup column as a String expression
      See Also:

    • description

      SelectableExpression description()
      Returns the long description of the action.
      Returns:
      the description column as a String expression
      See Also:

    • dueDate

      SelectableExpression dueDate()
      Returns the date and time by which the action should be done.

      Example: 

      
 def q = api.queryApi()
 def t = q.tables().actionItems()

 return q.source(t, [t.uniqueName(), t.assignedToName(), t.dueDate()], t.dueDate().lessThan(new Date()))
         .stream { it.collect { it } }
      Returns:
      the dueDate column as a DateTime expression
      See Also:

    • uniqueName

      SelectableExpression uniqueName()
      Returns the unique name of the Action Item.
      Returns:
      the uniqueName column as a String expression