ibi.broker.api.data.schedule
Class DynamicAddress

java.lang.Object
  ibi.broker.api.data.schedule.DynamicAddress

All Implemented Interfaces:

java.io.Serializable

public class DynamicAddress
extends java.lang.Object
implements java.io.Serializable

 The DynamicAddress class is used when a ReportCaster
  distribution list is created dynamically at runtime. The program
  creating a dynamic distribution list is a FOCUS Procedure residing on 
  reporting server. 

  The code below illustrates how DynamicAddress is used:

 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 +  Copyright (c) 2004 Information Builders, Inc. All  Rights Reserved.     +
 +                                                                          +
 +  Information Builders offers sample API programs as a heuristic device.  +
 +  They are not intended, as is, for production use. Licensed users are    +
 +  welcome to alter and extend these samples and deploy them in other      +
 +  environments, or alternate configurations, as they see fit.             +
 +  Information Builders will support the documented functionality of       +
 +  its API classes and methods. However, Information Builders is not       +
 +  responsible for functionality or behavior of products built with        +
 +  its API unless the documented behavior of its discrete classes and      +
 +  methods is different than the actual results.                           +
 +                                                                          +
 +  Redistributions of IBI source code and documentation must be within     +
 +  the scope of the Information Builders Software License Agreement.       +
 +                                                                          +
 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++  

  public DynamicAddress createDynamicAddress() //creation of the dynamic address object
        {
                DynamicAddress address = new DynamicAddress();
                address.setProcedureName("procedureName.fex");
                address.setServerName("ServerName");
                address.setUserName("user");
                address.setPassword("passw");
                return address;
        }
        public Destination createDestinationDynamic() //set dynamic address into destination object
        {
                Destination destination = new Destination();
                destination.setType(Destination.DYNAMIC_ADDRESS);
                DynamicAddress dynamicAddress = createDynamicAddress();
                destination.setDynamicAddress(dynamicAddress);
                return destination;
  

Version:

5.3

Author:

pgmyxc

See Also:

Serialized Form

Constructor Summary

DynamicAddress()

Method Summary

java.lang.String	getPassword() Returns the value of the password required for authentication to the reporting server containing the FOCUS Procedure that creates the dynamic distribution list.
java.lang.String	getProcedureName() Returns the name of the FOCUS Executable that produces the dynamic distribution list.
java.lang.String	getServerName() Returns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
java.lang.String	getUserName() Returns the logon name to the Reporting Server which the FOCUS Executable that creates the dynamic distribution list.
void	setPassword(java.lang.String password) Sets the value of the password required for authentication to the reporting server containing the FOCUS Procedure that creates the dynamic distribution list.
void	setProcedureName(java.lang.String procedureName) Assigns the name of the FOCUS Executable that produces the dynamic distribution list.
void	setServerName(java.lang.String serverName) Assigns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
void	setUserName(java.lang.String userName) Assigns the logon name to the Reporting Server which contains the FOCUS Executable that creates the dynamic distribution list.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicAddress

public DynamicAddress()

Method Detail

getPassword

public java.lang.String getPassword()

Returns the value of the password required for authentication to the reporting server containing the FOCUS Procedure that creates the dynamic distribution list.

Returns:

Returns the reporting server password as a String.

setPassword

public void setPassword(java.lang.String password)

Sets the value of the password required for authentication to the reporting server containing the FOCUS Procedure that creates the dynamic distribution list.

Parameters:

password - The reporting server password as a String.

getProcedureName

public java.lang.String getProcedureName()

Returns the name of the FOCUS Executable that produces the dynamic distribution list. Contains a maximum value of 64 characters.

Returns:

Returns the FOCUS Executable name as a String.

setProcedureName

public void setProcedureName(java.lang.String procedureName)

Assigns the name of the FOCUS Executable that produces the dynamic distribution list. Accepts a maximum value of 64 characters.

Parameters:

procedureName - The name of the FOCUS Executable that creates the Dynamic Distribution List, as a String.

getServerName

public java.lang.String getServerName()

Returns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.

Returns:

Returns The name of the server containing FOCUS Executable that creates the Dynamic Distribution List, as a String.

setServerName

public void setServerName(java.lang.String serverName)

Assigns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.

Parameters:

serverName - The name of the server containing FOCUS Executable that creates the Dynamic Distribution List, as a String.

getUserName

public java.lang.String getUserName()

Returns the logon name to the Reporting Server which the FOCUS Executable that creates the dynamic distribution list.

Returns:

Returns the logon name to the Reporting Server containing the FOCUS Executable that creates the dynamic distribution list as a String.

setUserName

public void setUserName(java.lang.String userName)

Assigns the logon name to the Reporting Server which contains the FOCUS Executable that creates the dynamic distribution list.

Parameters:

userName - The logon name to the Reporting Server containing the FOCUS Executable that creates the dynamic distribution list as a String.