PeopleFlowTypeService

Name PeopleFlowType
Version
Included Services  
Java Package org.kuali.rice.kew.framework.peopleflow

Interface for services that implement the type-specific behaviors of people flows.

Operations
Main Message Structures

Method filterToSelectableRoleIds
Description

Allows for the people flow to restrict the roles that can be selected when adding members to it.

Parameters String kewTypeId the people flow type identifier. Must not be null or blank.
StringList roleIds the set of ids to filter down. Must not be null.
Return StringList the roleIds from the above list that are valid to select. Will not return null.
Errors NONE No Errors

Back to Operations

Method resolveRoleQualifiers
Description

Resolve any role qualifiers for the given roleId, and document (along with documentContent).

Parameters String kewTypeId the people flow type identifier. Must not be null or blank.
String roleId the role that the qualifiers are specific to. Must not be null or blank.
Document document the document that the qualifiers are being resolved against. Must not be null.
DocumentContent documentContent the contents for the document that the qualifiers are being resolved against.
Must not be null.
Return Map the resolved role qualifiers. Will not return null.
Errors NONE No Errors

Back to Operations

Method getAttributeFields
Description

get the attributes supported by the people flow type with the given kewTypeId.

Parameters String kewTypeId the people flow type identifier. Must not be null or blank.
Return RemotableAttributeFieldList the {@link RemotableAttributeField}s that the PeopleFlow type with the given id supports.
Will not return null.
Errors NONE No Errors

Back to Operations

Method validateAttributes
Description

This method validates the passed in attributes for a kewTypeId generating a List of
{@link RemotableAttributeError}s.

Parameters String kewTypeId the people flow type identifier. Must not be null or blank.
Map attributes the attributes to validate. Cannot be null.
Return RemotableAttributeErrorList any errors that are discovered during validation. Will not return null.
Errors RiceIllegalArgumentException ???

Back to Operations

Method validateAttributesAgainstExisting
Description

This method validates the passed in attributes for a kewTypeId generating a List of
{@link RemotableAttributeError}s. This method used the oldAttributes to aid in validation. This is useful for
validating "new" or "updated" attributes.

Parameters String kewTypeId the people flow type identifier. Must not be null or blank.
Map newAttributes the kim type attributes to validate. Cannot be null.
Map oldAttributes the old attributes to use for validation. Cannot be null.
Return RemotableAttributeErrorList any errors that are discovered during validation. Will not return null.
Errors RiceIllegalArgumentException ???

Back to Operations