Skip navigation links

com.bea.security.providers.authorization.asi
Class InspectableFunction.ArgMetadata

java.lang.Object
com.bea.security.providers.authorization.asi.InspectableFunction.ArgMetadata

Enclosing interface:

InspectableFunction

public static class InspectableFunction.ArgMetadata

extends java.lang.Object

Argument meta data class is used to track meta data about an argument.

Meta data includes:

Number - starting with 0 as the 1st function argument, 1 as the 2nd arguments, 2 as the 3rd, etc.
Name - argument name to display by OAPM
Class - data type of the argument expressed as an OPSS class, with OpssString being the default class. OAPM supports OpssString, OpssInteger, and OpssBoolean data types. Any other data type specified via meta data results in OAPM assuming OpssString.
Allow Manual Entry - whether or not the argument may be entered manually.
Dependent - whether or not the argument is dependent on preceding arguments.
On Change Clear Dependent Args - whether or not a change to the argument resets all dependent arguments.

Constructor Summary

InspectableFunction.ArgMetadata(int argNumber, java.lang.String argName, java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType> argClass, boolean argAllowManualEntry, boolean argDependent, boolean argClearDependentArgs)
Constructor to intialize object holding meta data for a function argument.

Method Summary

java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType>	getArgClass() Returns class of the argument defined by the argument meta data instance.
java.lang.String	getArgName() Returns name of the argument defined by the argument meta data instance.
int	getArgNumber() Returns number of the argument defined by the argument meta data instance.
boolean	isArgAllowManualEntry() Returns whether or not the argument allows a value to be entered manually.
boolean	isArgDependent() Returns whether or not the argument is dependent on preceding attributes.
boolean	isArgOnChangeClearDependentArgs() Returns whether or not changing the argument should reset all dependent arguments.
protected void	setArgAllowManualEntry(boolean argAllowManualEntry) Sets whether or not the argument value can be entered manually.
protected void	setArgClass(java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType> argClass) Sets argument class.
protected void	setArgDependent(boolean argDependent) Sets whether or not the argument is dependent on preceding attributes.
protected void	setArgName(java.lang.String argName) Sets argument name.
protected void	setArgNumber(int argNumber) Sets argument number.
protected void	setArgOnChangeClearDependentArgs(boolean argOnChangeClearDependentArgs) Sets whether or not changing the argument should reset all dependent arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

InspectableFunction.ArgMetadata

public InspectableFunction.ArgMetadata(int argNumber,
                                       java.lang.String argName,
                                       java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType> argClass,
                                       boolean argAllowManualEntry,
                                       boolean argDependent,
                                       boolean argClearDependentArgs)

Constructor to intialize object holding meta data for a function argument.

Parameters:

argNumber - specify argument number as 0 for the 1st argument, 1 for the 2nd argument, 2 for the 3rd, etc.

argName - specify argument name as a short string to be displayed by OAPM.

argClass - specify argument class as OpssString.class, OpssInteger.class, or OpssBoolean.class.

argAllowManualEntry - specify whether or not the argument value can be entered manually.

argDependent - specify whether or not the argument is dependent on preceding arguments.

argClearDependentArgs - specify whether or not a change to the argument resets all dependent arguments.

Method Detail

getArgClass

public java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType> getArgClass()

Returns class of the argument defined by the argument meta data instance. The class is defined by oracle.security.jps.service.policystore.info.DataType.

Returns:

argument class

getArgName

public java.lang.String getArgName()

Returns name of the argument defined by the argument meta data instance.

Returns:

argument name

getArgNumber

public int getArgNumber()

Returns number of the argument defined by the argument meta data instance.

Returns:

argument number

isArgAllowManualEntry

public boolean isArgAllowManualEntry()

Returns whether or not the argument allows a value to be entered manually.

Returns:

true if manual entry is allowed, false otherwise.

isArgDependent

public boolean isArgDependent()

Returns whether or not the argument is dependent on preceding attributes.

Returns:

true if argument is dependent on preceding attributes, false otherwise.

isArgOnChangeClearDependentArgs

public boolean isArgOnChangeClearDependentArgs()

Returns whether or not changing the argument should reset all dependent arguments.

Returns:

true if changing the argument should reset all dependent arguments, false otherwise.

setArgAllowManualEntry

protected void setArgAllowManualEntry(boolean argAllowManualEntry)

Sets whether or not the argument value can be entered manually.

Parameters:

argAllowManualEntry - Specify whether or not the argument value can be entered manually.

setArgClass

protected void setArgClass(java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType> argClass)

Sets argument class.

Parameters:

argClass - Specify argument class as OpssString.class, OpssInteger.class, or OpssBoolean.class.

setArgDependent

protected void setArgDependent(boolean argDependent)

Sets whether or not the argument is dependent on preceding attributes.

Parameters:

argDependent - Specify whether or not the argument is dependent on preceding arguments.

setArgName

protected void setArgName(java.lang.String argName)

Sets argument name.

Parameters:

argName - Specify argument name as a short string to be displayed by OAPM.

setArgNumber

protected void setArgNumber(int argNumber)

Sets argument number.

Parameters:

argNumber - Specify argument number as 0 for the 1st argument, 1 for the 2nd argument, 2 for the 3rd, etc.

setArgOnChangeClearDependentArgs

protected void setArgOnChangeClearDependentArgs(boolean argOnChangeClearDependentArgs)

Sets whether or not changing the argument should reset all dependent arguments.

Parameters:

argOnChangeClearDependentArgs - Specify whether or not a change to the argument resets all dependent arguments.

Skip navigation links