Skip navigation links

oracle.iam.rm.client
Interface Argument

All Superinterfaces:

java.io.Serializable

public interface Argument

extends java.io.Serializable

A definition and placeholder interface for values used in invoking operations.

Method Summary

java.lang.String	getArgumentId() Gets the identifier for the argument.
PermissionFilter	getPermissionFilter() Gets the PermissionFilter for the argument.
java.lang.String	getRelatedObjectAttributeId() Gets the attribute identifier that this argument is associated with or null if it is not associated with an object's attribute.
java.lang.String	getRelatedObjectType() Gets the object type that this argument is associated with or returns null if this argument is not associated with an object.
java.lang.String	getTitle() Gets the title of this argument.
Type	getType() Gets the type of this argument.
Validator	getValidator() Gets the validator for the argument, allowing validation and "intelegent" UI rendering.
java.io.Serializable	getValue() Gets the curently stored value for this argument.
void	setValue(java.io.Serializable value) Updates the value stored in the argument.
java.lang.String	validate() Validates the current value of this argument against the attached validator.
boolean	wasSet() Determines whether the value in the argument was updated.

Method Detail

setValue

void setValue(java.io.Serializable value)

Updates the value stored in the argument.

Parameters:

value - Serializable new value for the argument

getArgumentId

java.lang.String getArgumentId()

Gets the identifier for the argument.

Returns:

String representing the argument identifier.

getPermissionFilter

PermissionFilter getPermissionFilter()

Gets the PermissionFilter for the argument.

Returns:

the PermissionFilter for the argument or null if there is no filter.

getValue

java.io.Serializable getValue()

Gets the curently stored value for this argument.

Returns:

Serializable representing the curently stored value for this argument or null if the value is not set.

getType

Type getType()

Gets the type of this argument.

Returns:

Type representing type of this argument.

getTitle

java.lang.String getTitle()

Gets the title of this argument.

Returns:

String representing title of this argument.

validate

java.lang.String validate()

Validates the current value of this argument against the attached validator.

Returns:

The error message of the current value if it fails validation, otherwise null.

See Also:

getValidator()

getRelatedObjectType

java.lang.String getRelatedObjectType()

Gets the object type that this argument is associated with or returns null if this argument is not associated with an object.

Returns:

String representing the object type that this argument is associated with or null if it is not associated with an object.

getRelatedObjectAttributeId

java.lang.String getRelatedObjectAttributeId()

Gets the attribute identifier that this argument is associated with or null if it is not associated with an object's attribute.

Returns:

String representing the attribute identifier that this argument is associated with or null if it is not associated with an object's attribute.

getValidator

Validator getValidator()

Gets the validator for the argument, allowing validation and "intelegent" UI rendering.

Returns:

Validator for the argument.

wasSet

boolean wasSet()

Determines whether the value in the argument was updated.

Returns:

true if the value stored in the argument was set, false otherwise.

Skip navigation links