API:EPrints/Workflow

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

---

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::Workflow - Models the submission process used by an repository.

DESCRIPTION

The workflow class handles loading the workflow configuration for a single repository.

WORKFLOW FORMAT

• component

Parents: stage

Children: field

Attributes: type

  <component type="Field::Multi">
    <field ref="title" />
    <field ref="abstract" />
  </component>

• field

Parents: component

Children: sub_field

Attributes: ref

  <field ref="title" input_cols="40" />

field includes a metafield in the workflow. Any property can be set for the field by supplying it as an attribute.

• flow

Parents: workflow

Children: stage

  <flow>
    <stage ref="files" />
    <stage ref="details" />
  </flow>

• stage

Parents: workflow, flow

Children: component

Attributes: ref, name

  <stage name="details">
    <component><field ref="title"/></component>
  </stage>

• sub_field

Parents: field

sub_field allows properties to be set for sub-fields of EPrints::MetaField::Compound and sub-classed field types.

See field for possible attributes.

• workflow

Children: flow, stage

  <workflow xmlns="http://eprints.org/ep3/workflow">
    <flow>
      ...
    </flow>
    <stage name="files">
      ...
    </stage>
    <stage name="details">
      ...
    </stage>
  </workflow>

METHODS

new

$language = EPrints::Workflow->new( $session, $workflow_id, %params )

Create a new workflow object representing the specification given in the workflow.xml configuration

1. needs more config - about object etc.

add_workflow_flow

$repository->add_workflow_flow( $workflowid, $id, $types, $stages )

Add a flow to the workflow which is applicable for the types in types and contains the stages in stages.

The $id is used to remove everything relating to this is from the workflow.

COPYRIGHT

Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.