Package com.pnfsoftware.jeb.core.actions

Class ActionXrefsData

java.lang.Object

com.pnfsoftware.jeb.core.actions.ActionData

com.pnfsoftware.jeb.core.actions.ActionXrefsData

All Implemented Interfaces:

IActionData

public class ActionXrefsData
extends ActionData

This action class holds information for to the Actions.QUERY_XREFS action.

Field Summary

Fields inherited from class com.pnfsoftware.jeb.core.actions.ActionData

ERRCODE_UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ActionXrefsData()

Method Summary

Modifier and Type	Method	Description
List<String>	getAddresses()	Get the list of addresses.
List<String>	getDetails()	Get a list of optional details, associated to the list of returned addresses.
int	getHintMaxResults()	Retrieve the optional cap for the number of references that the plugin should return.
String	getTarget()
List<String>	getUserAddresses()	Get a list of optional details, associated to the list of returned addresses.
void	setAddresses(List<String> addresses)	Set the list of addresses.
void	setDetails(List<String> details)	Set the list of detail strings.
void	setHintMaxResults(int hintMaxResults)	Set an optional cap for the number of references that the plugin should return.
void	setTarget(String target)	Can be used by the client or plugin.
void	setUserAddresses(List<String> userAddresses)	Set the list of user-friendly addresses.

Methods inherited from class com.pnfsoftware.jeb.core.actions.ActionData

canReuseObject, getDescription, getExecutionErrorCode, getExecutionErrorMessage, getValue, isNoInfoRequest, reset, setDescription, setExecutionError, setExecutionErrorCode, setExecutionErrorMessage, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

ActionXrefsData

public ActionXrefsData()

Method Details

setHintMaxResults

public void setHintMaxResults(int hintMaxResults)

Set an optional cap for the number of references that the plugin should return. This method is used by clients.

Parameters:

hintMaxResults - hint, may be set to 0 or negative to mean that no-cap

getHintMaxResults

public int getHintMaxResults()

Retrieve the optional cap for the number of references that the plugin should return. This method is used by plugins.

Returns:

cap hint, may be set to 0 or negative to mean that no-cap

getTarget

public String getTarget()

Returns:

setTarget

public void setTarget(String target)

Can be used by the client or plugin. If the client leaves it to null, it is up to the plugin to determine the wanted target address, and fill up this field. If the client provides it, the plugin must use it.

Parameters:

target -

getAddresses

public List<String> getAddresses()

Get the list of addresses. This method is used by clients.

Returns:

a list of addresses

setAddresses

public void setAddresses(List<String> addresses)

Set the list of addresses. This method is used by plugins.

Parameters:

addresses - list of addresses

getDetails

public List<String> getDetails()

Get a list of optional details, associated to the list of returned addresses. This method is used by clients. If non-null, must contain the same number of entries as getAddresses().

Returns:

if non-null, the length must be the same as the list of addresses; the individual elements may be null

setDetails

public void setDetails(List<String> details)

Set the list of detail strings. This method is used by plugins.

Parameters:

details -

getUserAddresses

public List<String> getUserAddresses()

Get a list of optional details, associated to the list of returned addresses. This method is used by clients. If non-null, must contain the same number of entries as getAddresses().

Returns:

an optional list of user addresses

setUserAddresses

public void setUserAddresses(List<String> userAddresses)

Set the list of user-friendly addresses. This method is used by plugins.

Parameters:

userAddresses -