Difference between revisions of "API:EPrints/Workflow"
| Line 1: | Line 1: | ||
<!-- Pod2Wiki=_preamble_ | <!-- Pod2Wiki=_preamble_ | ||
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | ||
| − | -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Workflow.pm|package_name=EPrints::Workflow}}[[Category:API|WORKFLOW]][[Category:API:EPrints/Workflow|WORKFLOW]]<div><!-- Edit below this comment --> | + | -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Workflow.pm|package_name=EPrints::Workflow}}[[Category:API|WORKFLOW]][[Category:API:EPrints/Workflow|WORKFLOW]]<div><!-- Edit below this comment --> |
Revision as of 15:26, 16 December 2011
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
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
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
<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
- 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
