API:EPrints/Workflow: Difference between revisions

Revision as of 10:30, 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: EPrints::Workflow/stage

Children: EPrints::Workflow/field

Attributes: type

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

User Comments

field

Parents: EPrints::Workflow/component

Children: 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.

User Comments

flow

Parents: EPrints::Workflow/workflow

Children: EPrints::Workflow/stage

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

User Comments

stage

Parents: EPrints::Workflow/workflow, EPrints::Workflow/flow

Children: EPrints::Workflow/component

Attributes: ref, name

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

User Comments

sub_field

Parents: EPrints::Workflow/field

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

See EPrints::Workflow/field for possible attributes.

User Comments

workflow

Children: EPrints::Workflow/flow, EPrints::Workflow/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

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

@@ Line 38: / Line 38: @@
 ===component===
-Parents: {{API:PodLink|file=|package_name=|section=stage|text=/stage}}
+Parents: [[API:EPrints/Workflow#stage|EPrints::Workflow/stage]]
-Children: {{API:PodLink|file=|package_name=|section=field|text=/field}}
+Children: [[API:EPrints/Workflow#field|EPrints::Workflow/field]]
 Attributes: type
@@ Line 59: / Line 59: @@
 ===field===
-Parents: {{API:PodLink|file=|package_name=|section=component|text=/component}}
+Parents: [[API:EPrints/Workflow#component|EPrints::Workflow/component]]
-Children: {{API:PodLink|file=|package_name=|section=sub_field|text=/sub_field}}
+Children: [[API:EPrints/Workflow#sub_field|EPrints::Workflow/sub_field]]
 Attributes: ref
@@ Line 79: / Line 79: @@
 ===flow===
-Parents: {{API:PodLink|file=|package_name=|section=workflow|text=/workflow}}
+Parents: [[API:EPrints/Workflow#workflow|EPrints::Workflow/workflow]]
-Children: {{API:PodLink|file=|package_name=|section=stage|text=/stage}}
+Children: [[API:EPrints/Workflow#stage|EPrints::Workflow/stage]]
    &lt;flow&gt;
@@ Line 98: / Line 98: @@
 ===stage===
-Parents: {{API:PodLink|file=|package_name=|section=workflow|text=/workflow}}, {{API:PodLink|file=|package_name=|section=flow|text=/flow}}
+Parents: [[API:EPrints/Workflow#workflow|EPrints::Workflow/workflow]], [[API:EPrints/Workflow#flow|EPrints::Workflow/flow]]
-Children: {{API:PodLink|file=|package_name=|section=component|text=/component}}
+Children: [[API:EPrints/Workflow#component|EPrints::Workflow/component]]
 Attributes: ref, name
@@ Line 118: / Line 118: @@
 ===sub_field===
-Parents: {{API:PodLink|file=|package_name=|section=field|text=/field}}
+Parents: [[API:EPrints/Workflow#field|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.
-See {{API:PodLink|file=|package_name=|section=field|text=/field}} for possible attributes.
+See [[API:EPrints/Workflow#field|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%; '>
@@ Line 134: / Line 134: @@
 ===workflow===
-Children: {{API:PodLink|file=|package_name=|section=flow|text=/flow}}, {{API:PodLink|file=|package_name=|section=stage|text=/stage}}
+Children: [[API:EPrints/Workflow#flow|EPrints::Workflow/flow]], [[API:EPrints/Workflow#stage|EPrints::Workflow/stage]]
    &lt;workflow xmlns="http://eprints.org/ep3/workflow"&gt;