com.rultor.spi

Interface Rule

@Immutable
public interface Rule

Rule.

Since:

1.0

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Method Summary

Methods

Modifier and Type	Method and Description
Spec	drain() Get drain spec.
String	failure() Read description of failure or empty string if there is no failure.
void	failure(String desc) Mark it as failed.
String	name() Get its name.
Spec	spec() Get spec.
void	update(Spec spec, Spec drain) Save spec.
Wallet	wallet(Coordinates work, com.jcabi.urn.URN taker, String rule) Wallet of the rule.

Method Detail

name

@NotNull(message="name of rule is never NULL")
String name()

Get its name.

Returns:

Name of it

update

void update(@NotNull(message="spec can\'t be NULL")
          Spec spec,
          @NotNull(message="drain can\'t be NULL")
          Spec drain)

Save spec.

Parameters:

spec - Spec to save

drain - Spec of drain

spec

@NotNull(message="spec is never NULL")
Spec spec()

Get spec.

Returns:

Spec

drain

@NotNull(message="spec of drain is never NULL")
Spec drain()

Get drain spec.

Returns:

Spec

failure

void failure(@NotNull(message="desc can\'t be NULL")
           String desc)

Mark it as failed.

Parameters:

desc - Description of a failure

failure

String failure()

Read description of failure or empty string if there is no failure.

Returns:

Description of it or empty string

wallet

@NotNull(message="wallet is never NULL")
Wallet wallet(Coordinates work,
                           com.jcabi.urn.URN taker,
                           String rule)
              throws Wallet.NotEnoughFundsException

Wallet of the rule.

Parameters:

work - Which work for

taker - Who is going to take money from my wallet?

rule - What this money is for?

Returns:

Wallet

Throws:

Wallet.NotEnoughFundsException - If not enough funds