org.alfresco.po.share.rules

Class RuleActions

java.lang.Object

org.alfresco.po.common.renderable.Renderable

org.alfresco.po.share.rules.RuleActions

@Component
public class RuleActions
extends Renderable

Rule actions

Since:

2.5

Author:

Kristijan Conkas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuleActions.Actions Action values.

Field Summary

Fields inherited from class org.alfresco.po.common.renderable.Renderable

renderableParent, webDriver

Constructor Summary

Constructors

Constructor and Description
RuleActions()

Method Summary

Modifier and Type	Method and Description
RuleActions	clickOnAdd() Click add action button.
void	clickOnCancel() Click cancel button.
void	clickOnCreate() Click create button.
RuleActions	clickOnRemove() Click remove action button.
RuleActions	deselectCreateRecordPath() Deselect the "Create record path" checkbox.
long	getActionRulesCount() Count the number of currently existing rules.
void	removeRuleByIndex(int index) Remove rule selected by index.
<T extends Renderable> T	render() Render method
RuleActions	selectAction(RuleActions.Actions action) Select action by action value.
RuleActions	selectActionByText(String name) Select action by text.
RuleActions	selectCreateRecordPath() Select the "Create record path" checkbox.
RuleActions	setRecordFolderPath(String path) Set the "Path to Record Folder" text box value.
RuleActions	withEmailParameters(List<String> recipients, String subject, String body) Set E-mail parameters for "Send email" action.
RuleActions	withEventName(String eventName) Set event name for "Complete event" action.
RuleActions	withRejectReason(String reason, Renderable parent) Reject record with "reason".
RuleActions	withRequestInformationParameters(List<String> usersAndGroups, String requestText, Renderable parent) Set text for request information action.
RuleActions	withRulePropertyByNameWithValue(String propertyName, String value) Select property by name for "Set property value" action.

Methods inherited from class org.alfresco.po.common.renderable.Renderable

as, getAllFields, getLastRendered, renderChildren

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleActions

public RuleActions()

Method Detail

selectAction

public RuleActions selectAction(RuleActions.Actions action)

Select action by action value.

Parameters:

action - Action to select.

Returns:

same class instance.

selectActionByText

public RuleActions selectActionByText(String name)

Select action by text.

Parameters:

name - Action text.

Returns:

same class instance.

removeRuleByIndex

public void removeRuleByIndex(int index)
                       throws IndexOutOfBoundsException

Remove rule selected by index.

Parameters:

index - Zero based index of rule to be removed.

Throws:

IndexOutOfBoundsException - if index < 0 or index > number of rules.

getActionRulesCount

public long getActionRulesCount()

Count the number of currently existing rules.

By default at least one (possibly empty) rule will exist.

Returns:

Number of rules

clickOnAdd

public RuleActions clickOnAdd()

Click add action button.

Returns:

This instance.

clickOnRemove

public RuleActions clickOnRemove()

Click remove action button.

Returns:

This instance.

setRecordFolderPath

public RuleActions setRecordFolderPath(String path)

Set the "Path to Record Folder" text box value.

Parameters:

path - Path.

Returns:

This instance.

selectCreateRecordPath

public RuleActions selectCreateRecordPath()

Select the "Create record path" checkbox.

Returns:

This instance.

deselectCreateRecordPath

public RuleActions deselectCreateRecordPath()

Deselect the "Create record path" checkbox.

Returns:

This instance.

withRejectReason

public RuleActions withRejectReason(String reason,
                                    Renderable parent)

Reject record with "reason".

Parameters:

reason - Reason for rejection.

parent - Renderable parent to return to.

Returns:

This instance.

withRequestInformationParameters

public RuleActions withRequestInformationParameters(List<String> usersAndGroups,
                                                    String requestText,
                                                    Renderable parent)

Set text for request information action.

Parameters:

usersAndGroups - List of users and groups to send this request to.

request - Text Request information text.

parent - Renderable parent to return to.

Returns:

This instance.

withEventName

public RuleActions withEventName(String eventName)

Set event name for "Complete event" action.

Parameters:

eventName -

Returns:

This instance.

withEmailParameters

public RuleActions withEmailParameters(List<String> recipients,
                                       String subject,
                                       String body)

Set E-mail parameters for "Send email" action.

Parameters:

recipients - List of recipients' Alfresco usernames.

subject - Subject line.

body - Message body.

Returns:

This instance.

withRulePropertyByNameWithValue

public RuleActions withRulePropertyByNameWithValue(String propertyName,
                                                   String value)

Select property by name for "Set property value" action.

Parameters:

propertyName. -

Returns:

This instance.

clickOnCreate

public void clickOnCreate()

Click create button.

clickOnCancel

public void clickOnCancel()

Click cancel button.

render

public <T extends Renderable> T render()

Description copied from class: Renderable

Render method

Overrides:

render in class Renderable