com.bmc.arsys.api

Class AssignFilterApiInfo

java.lang.Object

com.bmc.arsys.api.AssignFilterApiInfo

All Implemented Interfaces:

Serializable, Cloneable

public class AssignFilterApiInfo
extends Object
implements Cloneable, Serializable

The AssignFilterApiInfo class specifies a filter API result value to assign in a Set Fields action. You specify the name of the plug-in, the input values for the operation, and a pointer to the output values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssignFilterApiInfo() constructor
AssignFilterApiInfo(String service, List<AssignInfo> inputValues, long valueIndex) Constructs a new AssignFilterApiInfo object.

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
List<AssignInfo>	getInputValues() Returns the list of values that will be provided as input to the AR System filter (ARF) API plug-in.
String	getService() Returns the name of the plug-in.
long	getValueIndex() Returns the index into the returned list of values that will be used in the Set Field assignment.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setInputValues(List<AssignInfo> inputValues) Sets the list of values that will be provided as input to the AR System filter (ARF) API plug-in.
void	setService(String service) Sets the name of the plug-in.
void	setValueIndex(long valueIndex) Sets the index into the returned list of values that will be used in the Set Field assignment.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssignFilterApiInfo

public AssignFilterApiInfo()

constructor

AssignFilterApiInfo

public AssignFilterApiInfo(String service,
                           List<AssignInfo> inputValues,
                           long valueIndex)

Constructs a new AssignFilterApiInfo object.

Parameters:

service - Name of service in returned data

inputValues - Input value in returned data

valueIndex - Index of value in returned data

Method Detail

getService

public String getService()

Returns the name of the plug-in.

setService

public void setService(String service)

Sets the name of the plug-in.

getInputValues

public List<AssignInfo> getInputValues()

Returns the list of values that will be provided as input to the AR System filter (ARF) API plug-in.

setInputValues

public void setInputValues(List<AssignInfo> inputValues)

Sets the list of values that will be provided as input to the AR System filter (ARF) API plug-in.

getValueIndex

public long getValueIndex()

Returns the index into the returned list of values that will be used in the Set Field assignment.

setValueIndex

public void setValueIndex(long valueIndex)

Sets the index into the returned list of values that will be used in the Set Field assignment.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object