public class

ActionXrefsData

extends ActionData
java.lang.Object
   ↳ com.pnfsoftware.jeb.core.actions.ActionData
     ↳ com.pnfsoftware.jeb.core.actions.ActionXrefsData

Class Overview

This action class holds information for to the QUERY_XREFS action.

Summary

Public Constructors
ActionXrefsData()
Public Methods
List<String> getAddresses()
Get the list of addresses.
List<String> getDetails()
Get a list of optional details, associated to the list of returned addresses.
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 setTarget(String target)
Can be used by the client or plugin.
void setUserAddresses(List<String> userAddresses)
Set the list of user-friendly addresses.
[Expand]
Inherited Methods
From class com.pnfsoftware.jeb.core.actions.ActionData
From class java.lang.Object
From interface com.pnfsoftware.jeb.core.actions.IActionData

Public Constructors

public ActionXrefsData ()

Public Methods

public List<String> getAddresses ()

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

Returns
  • a list of addresses

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

public String getTarget ()

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

public void setAddresses (List<String> addresses)

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

Parameters
addresses list of addresses

public void setDetails (List<String> details)

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

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.

public void setUserAddresses (List<String> userAddresses)

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