Difference between revisions of "API:EPrints/Workflow"

From EPrints Documentation
Jump to: navigation, search
(Removing all content from page)
Line 1: Line 1:
 +
<!-- 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.
 +
-->{{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 -->
  
 +
 +
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 +
==NAME==
 +
'''EPrints::Workflow''' - Models the submission process used by an repository.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_description -->
 +
==DESCRIPTION==
 +
The workflow class handles loading the workflow configuration for a  single repository.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_workflow_format -->
 +
==WORKFLOW FORMAT==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_component -->
 +
===component===
 +
 +
Parents: {{API:PodLink|file=|package_name=|section=stage|text=/stage}}
 +
 +
Children: {{API:PodLink|file=|package_name=|section=field|text=/field}}
 +
 +
Attributes: type
 +
 +
  &lt;component type="Field::Multi"&gt;
 +
    &lt;field ref="title" /&gt;
 +
    &lt;field ref="abstract" /&gt;
 +
  &lt;/component&gt;
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_field -->
 +
===field===
 +
 +
Parents: {{API:PodLink|file=|package_name=|section=component|text=/component}}
 +
 +
Children: {{API:PodLink|file=|package_name=|section=sub_field|text=/sub_field}}
 +
 +
Attributes: ref
 +
 +
  &lt;field ref="title" input_cols="40" /&gt;
 +
 
 +
<tt>field</tt> includes a metafield in the workflow. Any property can be set for the field by supplying it as an attribute.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_flow -->
 +
===flow===
 +
 +
Parents: {{API:PodLink|file=|package_name=|section=workflow|text=/workflow}}
 +
 +
Children: {{API:PodLink|file=|package_name=|section=stage|text=/stage}}
 +
 +
  &lt;flow&gt;
 +
    &lt;stage ref="files" /&gt;
 +
    &lt;stage ref="details" /&gt;
 +
  &lt;/flow&gt;
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_stage -->
 +
===stage===
 +
 +
Parents: {{API:PodLink|file=|package_name=|section=workflow|text=/workflow}}, {{API:PodLink|file=|package_name=|section=flow|text=/flow}}
 +
 +
Children: {{API:PodLink|file=|package_name=|section=component|text=/component}}
 +
 +
Attributes: ref, name
 +
 +
  &lt;stage name="details"&gt;
 +
    &lt;component&gt;&lt;field ref="title"/&gt;&lt;/component&gt;
 +
  &lt;/stage&gt;
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_sub_field -->
 +
===sub_field===
 +
 +
Parents: {{API:PodLink|file=|package_name=|section=field|text=/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.
 +
 +
See {{API:PodLink|file=|package_name=|section=field|text=/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%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_workflow -->
 +
===workflow===
 +
 +
Children: {{API:PodLink|file=|package_name=|section=flow|text=/flow}}, {{API:PodLink|file=|package_name=|section=stage|text=/stage}}
 +
 +
  &lt;workflow xmlns="http://eprints.org/ep3/workflow"&gt;
 +
    &lt;flow&gt;
 +
      ...
 +
    &lt;/flow&gt;
 +
    &lt;stage name="files"&gt;
 +
      ...
 +
    &lt;/stage&gt;
 +
    &lt;stage name="details"&gt;
 +
      ...
 +
    &lt;/stage&gt;
 +
  &lt;/workflow&gt;
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_new -->
 +
===new===
 +
 +
$language = EPrints::Workflow-&gt;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.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_add_workflow_flow -->
 +
===add_workflow_flow===
 +
 +
$repository-&gt;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.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Revision as of 10:25, 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.4, 3.3) | 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


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/Workflow&oldid=9858’