Package org.dspace.xmlworkflow

Class Role

java.lang.Object

org.dspace.xmlworkflow.Role

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class Role
extends Object
implements org.springframework.beans.factory.BeanNameAware

The role that is responsible for a certain step Can either be on a group in the repo, or a collection group or an item role will check for workflowItemRoles

Author:

Bram De Schouwer (bram.deschouwer at dot com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Role.Scope

Constructor Summary

Constructors

Constructor	Description
Role()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getId()
RoleMembers	getMembers(Context context, XmlWorkflowItem wfi)
String	getName()
Role.Scope	getScope()
boolean	isInternal()
void	setBeanName(String s)
void	setDescription(String description)	Set the description of the role
void	setInternal(boolean internal)	Optional attribute which isn't really used at the moment, false by default
void	setName(String name)	The name specified in the name attribute of a role will be used to lookup the in DSpace.
void	setScope(Role.Scope scope)	Set the scope attribute, depending on the scope the users will be retrieved in the following manner: * collection: The collection value specifies that the group will be configured at the level of the collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Role

public Role()

Method Detail

setBeanName

public void setBeanName(String s)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getId

public String getId()

getName

public String getName()

getDescription

public String getDescription()

isInternal

public boolean isInternal()

getScope

public Role.Scope getScope()

getMembers

public RoleMembers getMembers(Context context,
                              XmlWorkflowItem wfi)
                       throws SQLException

Throws:

SQLException

setName

public void setName(String name)

The name specified in the name attribute of a role will be used to lookup the in DSpace. The lookup will depend on the scope specified in the "scope" attribute:

Parameters:

name -

setDescription

public void setDescription(String description)

Set the description of the role

Parameters:

description - the description

setScope

public void setScope(Role.Scope scope)

Set the scope attribute, depending on the scope the users will be retrieved in the following manner: * collection: The collection value specifies that the group will be configured at the level of the collection. * repository: The repository scope uses groups that are defined at repository level in DSpace. item: The item scope assumes that a different action in the workflow will assign a number of EPersons or Groups to a specific workflow-item in order to perform a step.

Parameters:

scope - the scope parameter

setInternal

public void setInternal(boolean internal)

Optional attribute which isn't really used at the moment, false by default

Parameters:

internal - if the role is internal