weborb.inspection
Class ArgumentDescriptor

java.lang.Object
  weborb.inspection.ArgumentDescriptor

All Implemented Interfaces:

IInspectionConstants, INamedType, IUseDirectFieldAccess

public class ArgumentDescriptor
extends java.lang.Object
implements INamedType, IInspectionConstants, IUseDirectFieldAccess

ArgumentDescriptor ArgumentDescriptor describes a method argument in an inspection response. Argument descriptors should be added to method descriprors (see MethodDescriptor) using MethodDescriptor.addArgument()

Author:

Midnight Coders, LLC

Field Summary

java.lang.String	description
java.lang.String	name
boolean	required
java.lang.String	type

Fields inherited from interface weborb.inspection.IInspectionConstants

ARGUMENTMETADATA, FUNCTIONMETADATA, SERVICEMETADATA

Constructor Summary

ArgumentDescriptor()

Method Summary

java.lang.String	getTypeName() This method is not intended for public use.
void	setArgumentName(java.lang.String name) Set argument name
void	setArgumentType(java.lang.String type) Set argument type.
void	setDescription(java.lang.String description) Set argument description
void	setIsRequired(boolean isRequired) Set a flag indicating whether the argument is required.

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

description

public java.lang.String description

type

public java.lang.String type

required

public boolean required

Constructor Detail

ArgumentDescriptor

public ArgumentDescriptor()

Method Detail

setArgumentName

public void setArgumentName(java.lang.String name)

Set argument name

Parameters:

name - name of the argument

setArgumentType

public void setArgumentType(java.lang.String type)

Set argument type. For example, for a java object, argument type is the class name

Parameters:

type - type of the argument

setDescription

public void setDescription(java.lang.String description)

Set argument description

Parameters:

description - description of the argument

setIsRequired

public void setIsRequired(boolean isRequired)

Set a flag indicating whether the argument is required. By default this value is true

Parameters:

isRequired -

getTypeName

public java.lang.String getTypeName()

This method is not intended for public use. It is required in this class for the implementation of INamedType

Specified by:

getTypeName in interface INamedType

Returns:

String name of the type