MAN page from OpenSuSE perl-OpenXPKI-Core-0.9.1389-6.362.CS.i586.rpm

OpenXPKI::Server::API::Workflow

Section: User Contributed Perl Documentation (3)
Updated: 2008-09-30
Index

Name

Description

This is the workflow interface which should be used by all user interfaces of OpenXPKI.A user interface MUST NOT access the server directly. The only allowedaccess is via this API. Any function which is not available in this API isnot for public use.The API gets access to the server via the 'server' context object. Thisobject must be set before instantiating the API.

Functions

new

Default constructor created by Class::Std.

get_config_id

Looks up the configuration ID for a given workflow ID (passed with thenamed parameter 'ID') from the database.

list_workflow_titles

Returns a hash ref containing all available workflow titles includinga description.

Return structure:{
title => description,
...}

search_workflow_instances

This function accesses the database directly in order to findWorkflow instances matching the specified search criteria.

Returns an array reference of the database query result.

Named parameters:

*: CONTEXT
The named parameter CONTEXT must be a hash reference.Apply search filter to search using the KEY/VALUE pair passed inCONTEXT and match all Workflow instances whose context contain allof the specified tuples.It is possible to use SQL wildcards such as % in the VALUE field.

Examples:

  my @workflow_ids = $api->search_workflow_instances(      {          CONTEXT =>              {                  KEY   => 'SCEP_TID',                  VALUE => 'ECB001D912E2A357E6E813D87A72E641',              },      }

*: TYPE (optional)
The named parameter TYPE can either be scalar or an array reference.Searches for workflows only of this type / these types.
*: STATE (optional)
The named parameter TYPE can either be scalar or an array reference.Searches for workflows only in this state / these states.
*: LIMIT (optional)
If given, limits the amount of workflows returned.
*: START (optional)
If given, defines the offset of the returned workflow (use with LIMIT).

search_workflow_instances_count

Works exactly the same as search_workflow_instances, but returns thenumber of results instead of the results themselves.

This document was created byman2html,using the manual pages.