Difference between revisions of "API:EPrints/Workflow"
| Line 38: | Line 38: | ||
===component=== | ===component=== | ||
| − | Parents: [[API:EPrints/Workflow#stage| | + | Parents: [[API:EPrints/Workflow#stage|]] |
| − | Children: [[API:EPrints/Workflow#field| | + | Children: [[API:EPrints/Workflow#field|]] |
Attributes: type | Attributes: type | ||
| Line 59: | Line 59: | ||
===field=== | ===field=== | ||
| − | Parents: [[API:EPrints/Workflow#component| | + | Parents: [[API:EPrints/Workflow#component|]] |
| − | Children: [[API:EPrints/Workflow#sub_field| | + | Children: [[API:EPrints/Workflow#sub_field|]] |
Attributes: ref | Attributes: ref | ||
| Line 79: | Line 79: | ||
===flow=== | ===flow=== | ||
| − | Parents: [[API:EPrints/Workflow#workflow| | + | Parents: [[API:EPrints/Workflow#workflow|]] |
| − | Children: [[API:EPrints/Workflow#stage| | + | Children: [[API:EPrints/Workflow#stage|]] |
<flow> | <flow> | ||
| Line 98: | Line 98: | ||
===stage=== | ===stage=== | ||
| − | Parents: [[API:EPrints/Workflow#workflow| | + | Parents: [[API:EPrints/Workflow#workflow|]], [[API:EPrints/Workflow#flow|]] |
| − | Children: [[API:EPrints/Workflow#component| | + | Children: [[API:EPrints/Workflow#component|]] |
Attributes: ref, name | Attributes: ref, name | ||
| Line 118: | Line 118: | ||
===sub_field=== | ===sub_field=== | ||
| − | Parents: [[API:EPrints/Workflow#field| | + | Parents: [[API:EPrints/Workflow#field|]] |
<tt>sub_field</tt> allows properties to be set for sub-fields of [[API:EPrints/MetaField/Compound|EPrints::MetaField::Compound]] and sub-classed field types. | <tt>sub_field</tt> allows properties to be set for sub-fields of [[API:EPrints/MetaField/Compound|EPrints::MetaField::Compound]] and sub-classed field types. | ||
| − | See [[API:EPrints/Workflow#field| | + | See [[API:EPrints/Workflow#field|]] for possible attributes. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 134: | Line 134: | ||
===workflow=== | ===workflow=== | ||
| − | Children: [[API:EPrints/Workflow#flow| | + | Children: [[API:EPrints/Workflow#flow|]], [[API:EPrints/Workflow#stage|]] |
<workflow xmlns="http://eprints.org/ep3/workflow"> | <workflow xmlns="http://eprints.org/ep3/workflow"> | ||
Revision as of 10:32, 7 April 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: [[API:EPrints/Workflow#stage|]]
Children: [[API:EPrints/Workflow#field|]]
Attributes: type
<component type="Field::Multi"> <field ref="title" /> <field ref="abstract" /> </component>
field
Parents: [[API:EPrints/Workflow#component|]]
Children: [[API:EPrints/Workflow#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: [[API:EPrints/Workflow#workflow|]]
Children: [[API:EPrints/Workflow#stage|]]
<flow> <stage ref="files" /> <stage ref="details" /> </flow>
stage
Parents: [[API:EPrints/Workflow#workflow|]], [[API:EPrints/Workflow#flow|]]
Children: [[API:EPrints/Workflow#component|]]
Attributes: ref, name
<stage name="details"> <component><field ref="title"/></component> </stage>
sub_field
Parents: [[API:EPrints/Workflow#field|]]
sub_field allows properties to be set for sub-fields of EPrints::MetaField::Compound and sub-classed field types.
See [[API:EPrints/Workflow#field|]] for possible attributes.
workflow
Children: [[API:EPrints/Workflow#flow|]], [[API:EPrints/Workflow#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
- 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
