com.prosyst.mprm.admin.procedures

Interface Argument

public interface Argument

Provides all the characteristics of a parameterized procedure argument. This interface aims at defining some particular argument types and methods to process the same arguments. It may be useful for facilitating and providing functionality for customized visual representation of procedure arguments as a part of its "metadata".

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTROL_UNIT_ARG Defines an argument type - Control Unit.
static java.lang.String	CONTROL_UNIT_FILTER_ARG Defines an argument type - Control Unit Filter.
static java.lang.String	DEVICE_ARG Defines an argument type - Device.
static java.lang.String	ENUMERATION_ARG Defines an argument type - Enumeration.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the description of the procedure argument.
int	getIndex() Gets the index of the procedure argument.
java.lang.String	getType() Gets the type of the argument.
java.lang.String[]	getValues() Gets the values if the type of the argument is ENUMERATED_TYPE.
void	setDescription(java.lang.String description) Sets user description of the argument.
void	setType(java.lang.String type) Sets the type of the argument.
void	setValues(java.lang.String[] values) Sets the values if the type of the argument is ENUMERATED_TYPE.

Field Detail

DEVICE_ARG

static final java.lang.String DEVICE_ARG

Defines an argument type - Device. On launching such a procedure, the Management Console will let the user browse to particular device and generate script filter that would match the specified device only.

See Also:

Constant Field Values

CONTROL_UNIT_ARG

static final java.lang.String CONTROL_UNIT_ARG

Defines an argument type - Control Unit. On launching such a procedure, the Management Console will let the user browse to particular control unit and generate script filter that would match the specified device only.

See Also:

Constant Field Values

CONTROL_UNIT_FILTER_ARG

static final java.lang.String CONTROL_UNIT_FILTER_ARG

Defines an argument type - Control Unit Filter. On launching such an procedure, the Management Console will let the user browse to particular control unit track record and generate script filter on the state variable of the specified track record.

See Also:

Constant Field Values

ENUMERATION_ARG

static final java.lang.String ENUMERATION_ARG

Defines an argument type - Enumeration. The Management Console will let the user fill a list of possible values and let him chose a possible value on procedure launching.

See Also:

Constant Field Values

Method Detail

getType

java.lang.String getType()
                  throws ManagementException

Gets the type of the argument. It can be one of the already defined types or an empty String.

Returns:

the type of the argument

Throws:

ManagementException - if system error occurs.

getDescription

java.lang.String getDescription()
                         throws ManagementException

Gets the description of the procedure argument. The description is used to explain the procedure argument to the user.

Returns:

the user description of the argument

Throws:

ManagementException - if system error occurs.

getIndex

int getIndex()
      throws ManagementException

Gets the index of the procedure argument. The return value will quote the procedure text and the filled value for this argument, e.g. if %1 argument in the procedure text will be replaced with the value for this argument before the execution the method will return 1. If this argument has never been set to a procedure, it has index 0.

Returns:

the argument index in the procedure text

Throws:

ManagementException - if system error occurs.

setDescription

void setDescription(java.lang.String description)
             throws ManagementException

Sets user description of the argument.

Parameters:

description - the new description of the argument

Throws:

ManagementException - if system error occurs.

setType

void setType(java.lang.String type)
      throws ManagementException

Sets the type of the argument. If the type is not one of the mentioned above, an ManagementException shall be thrown.

Parameters:

type - the new type of the argument

Throws:

ManagementException - if system error occurs or the argument is not defined type.

getValues

java.lang.String[] getValues()
                      throws ManagementException

Gets the values if the type of the argument is ENUMERATED_TYPE. Otherwise it will return null. If the type is mentioned above but there are no values for the argument the method will return null too.

Returns:

all set values for the argument

Throws:

ManagementException - if system error occurs.

setValues

void setValues(java.lang.String[] values)
        throws ManagementException

Sets the values if the type of the argument is ENUMERATED_TYPE. Otherwise it will set to null.

Parameters:

values - all the values to be set for the ENUMERATED argument

Throws:

ManagementException - if system error occurs.