Invoke (OpenNMS 18.0.3 API)

java.lang.Object
- org.opennms.netmgt.config.service.Invoke

All Implemented Interfaces:

Serializable
```
public class Invoke
extends Object
implements Serializable
```
Class Invoke.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Invoke()

Invoke(InvokeAtType type, Integer pass, String method, List<Argument> arguments)

Constructors
Constructor and Description
`Invoke()`
`Invoke(InvokeAtType type, Integer pass, String method, List<Argument> arguments)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArgument(Argument vArgument)`
`void`	`addArgument(int index, Argument vArgument)`
`void`	`deletePass()`
`Enumeration<Argument>`	`enumerateArgument()` Method enumerateArgument.
`boolean`	`equals(Object obj)` Overrides the java.lang.Object.equals method.
`Argument[]`	`getArgument()` Method getArgument.Returns the contents of the collection in an Array.
`Argument`	`getArgument(int index)` Method getArgument.
`List<Argument>`	`getArgumentCollection()` Method getArgumentCollection.Returns a reference to '_argumentList'.
`int`	`getArgumentCount()` Method getArgumentCount.
`InvokeAtType`	`getAt()` Returns the value of field 'at'.
`String`	`getMethod()` Returns the value of field 'method'.
`int`	`getPass()` Returns the value of field 'pass'.
`int`	`hashCode()` Overrides the java.lang.Object.hashCode method.
`boolean`	`hasPass()` Method hasPass.
`Iterator<Argument>`	`iterateArgument()` Method iterateArgument.
`void`	`removeAllArgument()`
`boolean`	`removeArgument(Argument vArgument)` Method removeArgument.
`Argument`	`removeArgumentAt(int index)` Method removeArgumentAt.
`void`	`setArgument(Argument[] vArgumentArray)`
`void`	`setArgument(int index, Argument vArgument)`
`void`	`setArgument(List<Argument> vArgumentList)` Sets the value of '_argumentList' by copying the given Vector.
`void`	`setAt(InvokeAtType at)` Sets the value of field 'at'.
`void`	`setMethod(String method)` Sets the value of field 'method'.
`void`	`setPass(int pass)` Sets the value of field 'pass'.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Invoke
```
public Invoke()
```
  - Invoke
```
public Invoke(InvokeAtType type,
              Integer pass,
              String method,
              List<Argument> arguments)
```
- Method Detail
  - addArgument
```
public void addArgument(Argument vArgument)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    vArgument -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addArgument
```
public void addArgument(int index,
                        Argument vArgument)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vArgument -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deletePass
```
public void deletePass()
```
  - enumerateArgument
```
public Enumeration<Argument> enumerateArgument()
```
    Method enumerateArgument.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - equals
```
public boolean equals(Object obj)
```
    Overrides the java.lang.Object.equals method.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    true if the objects are equal.
  - getArgument
```
public Argument getArgument(int index)
                     throws IndexOutOfBoundsException
```
    Method getArgument.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.opennms.netmgt.config.service.Argument at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getArgument
```
public Argument[] getArgument()
```
    Method getArgument.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getArgumentCollection
```
public List<Argument> getArgumentCollection()
```
    Method getArgumentCollection.Returns a reference to '_argumentList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getArgumentCount
```
public int getArgumentCount()
```
    Method getArgumentCount.
    
    Returns:
    
    the size of this collection
  - getAt
```
public InvokeAtType getAt()
```
    Returns the value of field 'at'.
    
    Returns:
    
    the value of field 'At'.
  - getMethod
```
public String getMethod()
```
    Returns the value of field 'method'.
    
    Returns:
    
    the value of field 'Method'.
  - getPass
```
public int getPass()
```
    Returns the value of field 'pass'.
    
    Returns:
    
    the value of field 'Pass'.
  - hasPass
```
public boolean hasPass()
```
    Method hasPass.
    
    Returns:
    
    true if at least one Pass has been added
  - hashCode
```
public int hashCode()
```
    Overrides the java.lang.Object.hashCode method.
    The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for the object.
  - iterateArgument
```
public Iterator<Argument> iterateArgument()
```
    Method iterateArgument.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - removeAllArgument
```
public void removeAllArgument()
```
  - removeArgument
```
public boolean removeArgument(Argument vArgument)
```
    Method removeArgument.
    
    Parameters:
    
    vArgument -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeArgumentAt
```
public Argument removeArgumentAt(int index)
```
    Method removeArgumentAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setArgument
```
public void setArgument(int index,
                        Argument vArgument)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vArgument -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setArgument
```
public void setArgument(Argument[] vArgumentArray)
```
    Parameters:
    
    vArgumentArray -
  - setArgument
```
public void setArgument(List<Argument> vArgumentList)
```
    Sets the value of '_argumentList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vArgumentList - the Vector to copy.
  - setAt
```
public void setAt(InvokeAtType at)
```
    Sets the value of field 'at'.
    
    Parameters:
    
    at - the value of field 'at'.
  - setMethod
```
public void setMethod(String method)
```
    Sets the value of field 'method'.
    
    Parameters:
    
    method - the value of field 'method'.
  - setPass
```
public void setPass(int pass)
```
    Sets the value of field 'pass'.
    
    Parameters:
    
    pass - the value of field 'pass'.

Class Invoke

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Invoke

Invoke

Method Detail

addArgument

addArgument

deletePass

enumerateArgument

equals

getArgument

getArgument

getArgumentCollection

getArgumentCount

getAt

getMethod

getPass

hasPass

hashCode

iterateArgument

removeAllArgument

removeArgument

removeArgumentAt

setArgument

setArgument

setArgument

setAt

setMethod

setPass