Difference between revisions of "API:EPrints/Workflow"

From EPrints Documentation
Jump to: navigation, search
Line 38: Line 38:
 
===component===
 
===component===
  
Parents: [[API:EPrints/Workflow#stage|]]
+
Parents: [[API:EPrints/Workflow#stage|stage]]
  
Children: [[API:EPrints/Workflow#field|]]
+
Children: [[API:EPrints/Workflow#field|field]]
  
 
Attributes: type
 
Attributes: type
Line 59: Line 59:
 
===field===
 
===field===
  
Parents: [[API:EPrints/Workflow#component|]]
+
Parents: [[API:EPrints/Workflow#component|component]]
  
Children: [[API:EPrints/Workflow#sub_field|]]
+
Children: [[API:EPrints/Workflow#sub_field|sub_field]]
  
 
Attributes: ref
 
Attributes: ref
Line 79: Line 79:
 
===flow===
 
===flow===
  
Parents: [[API:EPrints/Workflow#workflow|]]
+
Parents: [[API:EPrints/Workflow#workflow|workflow]]
  
Children: [[API:EPrints/Workflow#stage|]]
+
Children: [[API:EPrints/Workflow#stage|stage]]
  
 
   <flow>
 
   <flow>
Line 98: Line 98:
 
===stage===
 
===stage===
  
Parents: [[API:EPrints/Workflow#workflow|]], [[API:EPrints/Workflow#flow|]]
+
Parents: [[API:EPrints/Workflow#workflow|workflow]], [[API:EPrints/Workflow#flow|flow]]
  
Children: [[API:EPrints/Workflow#component|]]
+
Children: [[API:EPrints/Workflow#component|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|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|]] for possible attributes.
+
See [[API:EPrints/Workflow#field|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|]], [[API:EPrints/Workflow#stage|]]
+
Children: [[API:EPrints/Workflow#flow|flow]], [[API:EPrints/Workflow#stage|stage]]
  
 
   &lt;workflow xmlns="http://eprints.org/ep3/workflow"&gt;
 
   &lt;workflow xmlns="http://eprints.org/ep3/workflow"&gt;

Revision as of 10:34, 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


API: Core API

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


NAME

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

User Comments


DESCRIPTION

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

User Comments


WORKFLOW FORMAT

User Comments


component

Parents: stage

Children: field

Attributes: type

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

User Comments


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.

User Comments


flow

Parents: workflow

Children: stage

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

User Comments


stage

Parents: workflow, flow

Children: component

Attributes: ref, name

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

User Comments


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.

User Comments


workflow

Children: flow, stage

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

User Comments


METHODS

User Comments


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.

User Comments


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.

User Comments


COPYRIGHT

User Comments