com.prosyst.mprm.admin.operations

Class OperationPermanentOptions

java.lang.Object

com.prosyst.mprm.admin.operations.OperationPermanentOptions

public class OperationPermanentOptions
extends java.lang.Object

The OperationPermanentOption class defines the execution behavior of permanent operations. It provides a set of permanent options (flags), which could be arbitrary combined by the operation initiator to define the preferred permanent execution behavior.
Example:
Operation operation; // creating some operation...
OperationPermanentOptions options = new OperationPermanentOptions();
options.setOption(OperationPermanentOptions.EXECUTE_ON_CONNECT, true);
operation.setPermanent(options);

Field Summary

Fields

Modifier and Type	Field and Description
static int	DONT_EXECUTE_ON_CURRENT_DEVICES If this option is raised, the operation will not be started on the current set of devices, but will only affect newly registered and/or connected devices, regarding the other options.
static int	EVALUATE_ONCE This option is evaluated only if the EXECUTE_ON_CONNECT is raised.
static int	EXECUTE_ON_CONNECT If this option is raised, the operation will be executed on devices every time they connect to mPRM.
static int	EXECUTE_ON_REGISTER If this option is raised, the operation will be executed on newly registered devices.
protected int	options Holds permanent options as bit flags in an integer value.
static int	REQUIRE_USER_CONFIRMATION If this option is raised, the operation will wait for user confirmation on each device to be executed.

Constructor Summary

Constructors

Constructor and Description
OperationPermanentOptions() Creates an OperationPermanentOptions object.

Method Summary

Modifier and Type	Method and Description
boolean	getOption(int option) Checks whether a given permanent option is raised or not within this object.
int	getOptions() Method used by the system to get all flags in an integer value
void	setOption(int option, boolean flag) Sets a given permanent option.
void	setOptions(int options) Method used by the system to set all flags within an integer value
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTE_ON_REGISTER

public static final int EXECUTE_ON_REGISTER

If this option is raised, the operation will be executed on newly registered devices. Use setOption(EXECUTE_ON_REGISTER, true) to raise this option.

See Also:

Constant Field Values

EXECUTE_ON_CONNECT

public static final int EXECUTE_ON_CONNECT

If this option is raised, the operation will be executed on devices every time they connect to mPRM. Use setOption(EXECUTE_ON_CONNECT, true) to raise this option.

See Also:

Constant Field Values

DONT_EXECUTE_ON_CURRENT_DEVICES

public static final int DONT_EXECUTE_ON_CURRENT_DEVICES

If this option is raised, the operation will not be started on the current set of devices, but will only affect newly registered and/or connected devices, regarding the other options. Use setOption(DONT_EXECUTE_ON_CURRENT_DEVICES, true) to raise this option.

See Also:

Constant Field Values

REQUIRE_USER_CONFIRMATION

public static final int REQUIRE_USER_CONFIRMATION

If this option is raised, the operation will wait for user confirmation on each device to be executed. Use setOption(REQUIRE_USER_CONFIRMATION, true) to raise this option.

See Also:

Constant Field Values

EVALUATE_ONCE

public static final int EVALUATE_ONCE

This option is evaluated only if the EXECUTE_ON_CONNECT is raised. If EVALUATE_ONCE is raised, the operation will be executed on devices only once, i.e. the first time they connect to the mPRM, on every following connect the operation will not be executed. Use setOption(EVALUATE_ONCE, true) to raise this option.

See Also:

Constant Field Values

options

protected int options

Holds permanent options as bit flags in an integer value. Options are placed on positions as follows, considering the less significant bit at position 0:
EXECUTE_ON_REGISTER - 0
EXECUTE_ON_CONNECT - 1
DONT_EXECUTE_ON_CURRENT_DEVICES - 2
REQUIRE_USER_CONFIRMATION - 3

Constructor Detail

OperationPermanentOptions

public OperationPermanentOptions()

Creates an OperationPermanentOptions object.

Method Detail

getOption

public boolean getOption(int option)

Checks whether a given permanent option is raised or not within this object.

Parameters:

option - could be one of the integer constants.

Returns:

true if the given option is raised, false otherwise.

setOption

public void setOption(int option,
                      boolean flag)

Sets a given permanent option.

Parameters:

option - could be one of the integer constants.

flag - boolean value indicating whether the permanent option is to be raised or dropped.

getOptions

public int getOptions()

Method used by the system to get all flags in an integer value

Returns:

integer representation of all raised flags.

setOptions

public void setOptions(int options)

Method used by the system to set all flags within an integer value

Parameters:

options - integer value containing all raised flags.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object