com.ibm.notes.java.api.data
Class NotesAgentData

java.lang.Object
  com.ibm.notes.java.api.data.NotesAgentData

public class NotesAgentData
extends Object

Class that contains data that would be associated with a Notes agent.

Constructor Summary

NotesAgentData(NotesDatabaseData database, String name)
Constructs a NotesAgentData object.

Method Summary

Object	addItem(String name, Object value) Adds an item and its associated value to the items that could be used to compose a document the agent will run on.
boolean	equals(Object obj) Determines whether two NotesAgentData objects are equal.
NotesDatabaseData	getDatabaseData() Gets the data of the database containing the agent.
Map	getItems() Gets the map of items to values for the document the agent will use.
String	getName() Gets the unencoded name of the agent
Object	removeItem(String name) Removes the item and its associated value from the items used to compose the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotesAgentData

public NotesAgentData(NotesDatabaseData database,
                      String name)
               throws NotesException 

Constructs a NotesAgentData object.

Parameters:

database - the data of the database containing the agent

name - the unencoded name of the agent

Throws:

NotesException - thrown when the NotesAgentData object cannot be constructed

Since:

1.5.1

Method Detail

getDatabaseData

public NotesDatabaseData getDatabaseData()

Gets the data of the database containing the agent.

Returns:

the data of the database containing the agent

Since:

1.5.1

getName

public String getName()

Gets the unencoded name of the agent

Returns:

the unencoded name of the agent

Since:

1.5.1

addItem

public Object addItem(String name,
                      Object value)

Adds an item and its associated value to the items that could be used to compose a document the agent will run on. The name is the name of the item on the form you would like to set. We only support simple objects (String, Integer, etc.) as a values at this time. The value can be any of the following: Text: String
Number: Integer, Double
DateTime: Date, Calendar
List: List of single type of above items

Parameters:

name - name of the item on the document you would like to set

value - the value to set the item to

Returns:

the object previously associated with the name of that item, or null if there wasn't one

Since:

1.5.1

removeItem

public Object removeItem(String name)

Removes the item and its associated value from the items used to compose the document.

Parameters:

name - the name of the item to remove

Returns:

previous value associated with specified item, or null if there was no value for the item

Since:

1.5.1

getItems

public Map getItems()

Gets the map of items to values for the document the agent will use.

Returns:

the map of items to values for the document the agent will use

Since:

1.5.1

equals

public boolean equals(Object obj)

Determines whether two NotesAgentData objects are equal.

Overrides:

equals in class Object

Returns:

true if the two objects are equal false otherwise

Since:

1.5.1