A B C D E F G H I J L M N O P R S T U V W X Y

A

AbstractWebService - Class in ibi.broker.api.ws
 
AbstractWebService() - Constructor for class ibi.broker.api.ws.AbstractWebService
 
ACCESS_TYPE_LIST - Static variable in class ibi.broker.api.data.library.Content
String constant representing one of the three valid access options.
ACCESS_TYPE_OWNER - Static variable in class ibi.broker.api.data.library.Content
String constant representing one of the three valid access options.
ACCESS_TYPE_PUBLIC - Static variable in class ibi.broker.api.data.library.Content
String constant representing one of the three valid access options.
AccessElement - Class in ibi.broker.api.data.libraryaccess
The AccessElement class allows you to add members to an Access List, either as individual users or as a group.
AccessElement() - Constructor for class ibi.broker.api.data.libraryaccess.AccessElement
 
addAccessElement(String, AccessElement) - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
addAccessElement(String, AccessElement) - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
addAccessElement(Authenticate, String, AccessElement) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
addAddressBook(AddrBook) - Method in interface ibi.broker.api.cci.AddressBookManager
Creates an Address Book in the ReportCaster Repository.
addAddressBook(AddrBook) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
addAddressBook(Authenticate, AddrBook) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
addAddressBook(Authenticate, AddrBook) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
addCustomInterval(TimeInfo) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
addDestinationElement(String, DestinationElement) - Method in interface ibi.broker.api.cci.AddressBookManager
Adds a DestinationElement to the Address Book specified by bookName.
addDestinationElement(String, DestinationElement) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
addDestinationElement(Authenticate, String, DestinationElement) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
addDestinationElement(Authenticate, String, DestinationElement) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
addExecId(ExecId) - Method in interface ibi.broker.api.cci.UserManager
 
addExecId(ExecId) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
addGroup(Group) - Method in interface ibi.broker.api.cci.UserManager
Adds group information, as encapsulated in the specified Group object, to the underlying repository.
addGroup(Group) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
addGroup(Authenticate, Group) - Method in interface ibi.broker.api.ws.UserManagerIF
 
addGroup(Authenticate, Group) - Method in class ibi.broker.api.ws.UserManagerWS
 
addLibraryAccessBook(LibraryAccessBook) - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
addLibraryAccessBook(LibraryAccessBook) - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
addLibraryAccessBook(Authenticate, LibraryAccessBook) - Method in interface ibi.broker.api.ws.LibraryAccessManagerIF
 
addLibraryAccessBook(Authenticate, LibraryAccessBook) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
addParameter(Parameter) - Method in class ibi.broker.api.data.schedule.TaskUrl
 
addParameter(Parameter) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
AddrBook - Class in ibi.broker.api.data.addrbook
The AddrBook class creates and configures ReportCaster Address Books.
AddrBook() - Constructor for class ibi.broker.api.data.addrbook.AddrBook
 
AddressBookManager - Interface in ibi.broker.api.cci
This interface provides all of the basic functions for managing ReportCaster's distribution list information.
AddressBookManagerClientSF - Class in ibi.broker.api.ws
 
AddressBookManagerClientSF(String, String, String) - Constructor for class ibi.broker.api.ws.AddressBookManagerClientSF
 
AddressBookManagerIF - Interface in ibi.broker.api.ws
 
AddressBookManagerWS - Class in ibi.broker.api.ws
 
AddressBookManagerWS() - Constructor for class ibi.broker.api.ws.AddressBookManagerWS
 
addSchedule(Schedule) - Method in interface ibi.broker.api.cci.ScheduleManager
Takes a Schedule object and adds it to the ReportCaster repository.
addSchedule(Schedule) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
addSchedule(Authenticate, Schedule) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
addSchedule(Authenticate, Schedule) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
addUser(User) - Method in interface ibi.broker.api.cci.UserManager
Adds the properties of a specified ReportCaster user, as contained in the passed User object, to the underlying database or repository.
addUser(User) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
addUser(Authenticate, User) - Method in interface ibi.broker.api.ws.UserManagerIF
 
addUser(Authenticate, User) - Method in class ibi.broker.api.ws.UserManagerWS
 
addUserInToGroup(String, String) - Method in interface ibi.broker.api.cci.UserManager
Adds a userName to an existing group in the underlying repository, as identified by its group name.
addUserInToGroup(String, String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
addUserInToGroup(Authenticate, String, String) - Method in interface ibi.broker.api.ws.UserManagerIF
 
addUserInToGroup(Authenticate, String, String) - Method in class ibi.broker.api.ws.UserManagerWS
 
addWatchItem(WatchItem) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
addWatchItem(Authenticate, WatchItem) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
addWatchItem(Authenticate, WatchItem) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
AHTML - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
AHTML - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format AHTML.
Alert - Class in ibi.broker.api.data.schedule
The Alert class represents the information needed to set up an Alert Schedule in ReportCaster.
Alert() - Constructor for class ibi.broker.api.data.schedule.Alert
 
ALPHA - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format ALPHA.
ALWAYS - Static variable in class ibi.broker.api.data.schedule.Notification
Notification type indicating to always notify upon running of Schedule.
AmperParameter - Class in ibi.broker.api.data.schedule
AmperParameter is used to specify, discover, and retrieve parameter names and values located within a FOCUS procedure.
AmperParameter() - Constructor for class ibi.broker.api.data.schedule.AmperParameter
 
APDF - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
Authenticate - Class in ibi.broker.api.data
This class is for use with the ReportCaster Web Services API and stateless applications.
Authenticate() - Constructor for class ibi.broker.api.data.Authenticate
 
authenticate - Static variable in class ibi.broker.api.ws.CasterServiceClient
 
AUTO - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of AUTO.

B

base - Static variable in class ibi.broker.api.ws.CasterServiceClient
 

C

CacheableDBLocatorExit - Interface in ibi.broker.scheduler.plugin
CacheableDBLocatorExit is an interface describing a Java class that can be used to retrieve the database URL, used ID and password for JDBC driver.
CasterConnection - Class in ibi.broker.api.cci
The ReportCaster API makes use of the Java Connection Architecture (JCA) to integrate client application components with the ReportCaster Repository and Distribution Server.
CasterConnection(ManagedConnection, ConnectionRequestInfo) - Constructor for class ibi.broker.api.cci.CasterConnection
Constructor for CasterConnection.
CasterConnectionFactory - Class in ibi.broker.api.cci
This class is used with the CasterConnection and CasterManagedConnectionFactory classes to connect to ReportCaster.
CasterConnectionFactory(ConnectionManager, ManagedConnectionFactory) - Constructor for class ibi.broker.api.cci.CasterConnectionFactory
Primary constructor for CasterConnectionFactory.
CasterConnectionMetaData - Class in ibi.broker.api.cci
This class provides information about an EIS instance connected through a CasterConnection instance.
CasterConnectionMetaData(ManagedConnectionMetaData) - Constructor for class ibi.broker.api.cci.CasterConnectionMetaData
Constructor for CasterConnectionMetaData.
CasterException - Exception in ibi.broker.api.data
CasterException is a generic exception class, which encapsulates the majority of error conditions that can occur within ReportCaster.
CasterException(String) - Constructor for exception ibi.broker.api.data.CasterException
 
CasterException(String, String) - Constructor for exception ibi.broker.api.data.CasterException
 
CasterException(String, String, String) - Constructor for exception ibi.broker.api.data.CasterException
 
CasterException(String, String, Object[]) - Constructor for exception ibi.broker.api.data.CasterException
 
CasterException(String, String, Throwable) - Constructor for exception ibi.broker.api.data.CasterException
 
CasterManagedConnectionFactory - Class in ibi.broker.api
Within the ReportCaster API, the CasterManagedConnectionFactory class along with the CasterConnectionFactoryand CasterConnection classes are the primary means for obtaining connections to ReportCaster.
CasterManagedConnectionFactory() - Constructor for class ibi.broker.api.CasterManagedConnectionFactory
Constructor for CasterManagedConnectionFactory.
CasterManagedConnectionFactoryMigration - Class in ibi.broker.api
 
CasterManagedConnectionFactoryMigration() - Constructor for class ibi.broker.api.CasterManagedConnectionFactoryMigration
 
CasterResourceAdapterMetaData - Class in ibi.broker.api.cci
This class provides information about ReportCaster's resource adapter implementation.
CasterResourceAdapterMetaData() - Constructor for class ibi.broker.api.cci.CasterResourceAdapterMetaData
Constructor for the ResourceAdapterMetaData implementation.
CasterServiceClient - Class in ibi.broker.api.ws
 
CasterServiceClient() - Constructor for class ibi.broker.api.ws.CasterServiceClient
 
Category - Class in ibi.broker.api.data.library
The Category class provides a means of categorizing, storing and manipulating report library reports.
Category() - Constructor for class ibi.broker.api.data.library.Category
 
changeJobPriority(String, int) - Method in interface ibi.broker.api.cci.ConsoleManager
Given a job id, which uniquely identifies a job, and an integer of 1 thru 5 representing a priority, changes the order of execution of the specified Distribution Server job to the new priority.
changeJobPriority(Authenticate, String, int) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
changeJobPriority(Authenticate, String, int) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
close() - Method in class ibi.broker.api.cci.CasterConnection
Closes this connection to the EIS (for example, ReportCaster Repository).
COM - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
COMMA - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format COMMA.
COMT - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format COMT.
ConfigManager - Interface in ibi.broker.api.cci
 
connectionFactory - Variable in class ibi.broker.api.ws.AbstractWebService
 
CONSOLE_MODE - Static variable in class ibi.broker.api.CasterManagedConnectionFactory
 
ConsoleManager - Interface in ibi.broker.api.cci
ConsoleManager This interface provides API users with the ability to access information about jobs on the ReportCaster Distribution Server as well as jobs on queue to run on the ReportCasetr Distribution Server.
ConsoleManagerClientSF - Class in ibi.broker.api.ws
 
ConsoleManagerClientSF(String, String, String) - Constructor for class ibi.broker.api.ws.ConsoleManagerClientSF
 
ConsoleManagerIF - Interface in ibi.broker.api.ws
 
ConsoleManagerWS - Class in ibi.broker.api.ws
 
ConsoleManagerWS() - Constructor for class ibi.broker.api.ws.ConsoleManagerWS
 
Content - Class in ibi.broker.api.data.library
 
Content() - Constructor for class ibi.broker.api.data.library.Content
 
CONTINUE - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of CONTINUE.
copy() - Method in class ibi.broker.api.data.addrbook.AddrBook
Generates a copy of the passed AddrBook.
copy() - Method in class ibi.broker.api.data.addrbook.DestinationElement
Copies this instance of DistributionElement.
createCCIConnection(Authenticate) - Method in class ibi.broker.api.ws.AbstractWebService
 
createConnectionFactory(ConnectionManager) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Creates a CasterConnectionFactory instance.
createConnectionFactory() - Method in class ibi.broker.api.CasterManagedConnectionFactory
Creates a CasterConnectionFactory instance.
createConnectionFactory() - Method in class ibi.broker.api.CasterManagedConnectionFactoryMigration
 
createInteraction() - Method in class ibi.broker.api.cci.CasterConnection
This method is currently not available for use within the API.
createJobs(String, String, String, String) - Method in class ibi.broker.api.ws.ConsoleManagerClientSF
 
createManagedConnection(Subject, ConnectionRequestInfo) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Creates a new physical connection to ReportCaster's underlying Repository.
createScheduleInstance(int, String, int) - Method in interface ibi.broker.api.cci.ScheduleManager
Creates a new Schedule object with specified integer constant values for IntervalType, distributionType, and taskType.
createScheduleInstance(int, String, int) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
createScheduleInstance(Authenticate, int, String, int) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
createScheduleInstance(Authenticate, int, String, int) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
createScheduleInstanceDefault() - Method in interface ibi.broker.api.cci.ScheduleManager
Creates a new Schedule object with default schedule property values.
createScheduleInstanceDefault() - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
createScheduleInstanceDefault(Authenticate) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
createScheduleInstanceDefault(Authenticate) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
Credential - Interface in ibi.broker.api.cci
This interface passes connection request-specific properties to the CasterConnectionFactory.getConnection() method.
CUSTOM - Static variable in class ibi.broker.api.data.schedule.TimeInfo
 

D

DAY - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of a DAY.
DAY - Static variable in class ibi.broker.api.data.schedule.TimeInfo
Interval type indicating execution daily.
DAY - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
DB - Static variable in class ibi.broker.api.CasterManagedConnectionFactory
Repository type representing a RDMS database.
DBLocatorExit - Interface in ibi.broker.scheduler.plugin
DBLocatorExit is an interface describing a Java class that can be used to retrieve the database URL, used ID and password for JDBC driver.
DefaultSFTPSecurityExit - Class in ibi.broker.scheduler.plugin
A default SFTPSecurityExit implementation to get the public key authentication information from the file sftp_private_key.txt under Distribution Server /cfg directory
DefaultSFTPSecurityExit() - Constructor for class ibi.broker.scheduler.plugin.DefaultSFTPSecurityExit
 
DefaultSMTPSecurityExit - Class in ibi.broker.scheduler.plugin
 
DefaultSMTPSecurityExit() - Constructor for class ibi.broker.scheduler.plugin.DefaultSMTPSecurityExit
 
DELETE_USER_DELETE_SCHEDULE - Static variable in interface ibi.broker.api.cci.UserManager
One of three constants indicating the deleteType where the user is deleted along with the all schedules owned by the user.
DELETE_USER_ONLY - Static variable in interface ibi.broker.api.cci.UserManager
One of three constants indicating the deleteType where only the user is deleted.
DELETE_USER_SET_SCHEDULE_INACTIVE - Static variable in interface ibi.broker.api.cci.UserManager
One of three constants indicating the deleteType where the user is deleted and all the schedules owned by the user are set to inactive.
deleteAccessElement(String, AccessElement) - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
deleteAccessElement(String, AccessElement) - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
deleteAccessElement(Authenticate, String, AccessElement) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
deleteAddressBook(String) - Method in interface ibi.broker.api.cci.AddressBookManager
Deletes the Address Book specified by bookName.
deleteAddressBook(String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
deleteAddressBook(Authenticate, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
deleteAddressBook(Authenticate, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
deleteContent(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Deletes the content description and all associated report versions from the ReportCaster Repository.
deleteContent(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
deleteContent(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
deleteContent(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
deleteContentByScheduleId(String, String) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
deleteDestinationElement(String, DestinationElement) - Method in interface ibi.broker.api.cci.AddressBookManager
Deletes a DestinationElement from the Address Book specified by bookName.
deleteDestinationElement(String, DestinationElement) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
deleteDestinationElement(Authenticate, String, DestinationElement) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
deleteDestinationElement(Authenticate, String, DestinationElement) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
deleteExecId(ExecId) - Method in interface ibi.broker.api.cci.UserManager
 
deleteExecId(ExecId) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
deleteGroup(String) - Method in interface ibi.broker.api.cci.UserManager
Deletes group information, as encapsulated in the specified Group object, from the underlying repository.
deleteGroup(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
deleteGroup(Authenticate, String) - Method in interface ibi.broker.api.ws.UserManagerIF
 
deleteGroup(Authenticate, String) - Method in class ibi.broker.api.ws.UserManagerWS
 
deleteLibraryAccessBook(String) - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
deleteLibraryAccessBook(String) - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
deleteLibraryAccessBook(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryAccessManagerIF
 
deleteLibraryAccessBook(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
deleteLogByJobId(String) - Method in interface ibi.broker.api.cci.LogManager
Deletes a specific log record as identified by its unique job ID from the underlying repository.
deleteLogByJobId(String) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
deleteLogByJobId(Authenticate, String) - Method in interface ibi.broker.api.ws.LogManagerIF
 
deleteLogByJobId(Authenticate, String) - Method in class ibi.broker.api.ws.LogManagerWS
 
deleteLogList(Calendar, Calendar) - Method in interface ibi.broker.api.cci.LogManager
Deletes the log records from the underlying repository pertaining to all schedules which were run between a specified time interval delineated by startTime and endTime.
deleteLogList(Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
deleteLogList(Authenticate, Calendar, Calendar) - Method in interface ibi.broker.api.ws.LogManagerIF
 
deleteLogList(Authenticate, Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerWS
 
deleteLogListByOwner(String, Calendar, Calendar) - Method in interface ibi.broker.api.cci.LogManager
Deletes the log records from the underlying repository pertaining to all schedules owned by the specified user, and which were run between a specified time interval delineated by startTime and endTime.
deleteLogListByOwner(String, Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
deleteLogListByOwner(Authenticate, String, Calendar, Calendar) - Method in interface ibi.broker.api.ws.LogManagerIF
 
deleteLogListByOwner(Authenticate, String, Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerWS
 
deleteLogListByScheduleId(String) - Method in interface ibi.broker.api.cci.LogManager
Deletes log records from the underlying ReportCaster repository associated with a specified schedule as identified by the passed scheduleId.
deleteLogListByScheduleId(String) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
deleteLogListByScheduleId(Authenticate, String) - Method in interface ibi.broker.api.ws.LogManagerIF
 
deleteLogListByScheduleId(Authenticate, String) - Method in class ibi.broker.api.ws.LogManagerWS
 
deleteLogListByScheduleIdByCalendar(String, Calendar, Calendar) - Method in interface ibi.broker.api.cci.LogManager
Deletes the log records from the underlying repository pertaining to a specific scheduleID and to only those log jobs which were run between a specified time interval, delineated by startTime and endTime.
deleteLogListByScheduleIdByCalendar(String, Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
deleteLogListByScheduleIdByCalendar(Authenticate, String, Calendar, Calendar) - Method in interface ibi.broker.api.ws.LogManagerIF
 
deleteLogListByScheduleIdByCalendar(Authenticate, String, Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerWS
 
deleteRunningJobsFromDS(Object[]) - Method in interface ibi.broker.api.cci.ConsoleManager
 
deleteSchedule(String) - Method in interface ibi.broker.api.cci.ScheduleManager
Deletes the schedule as identified by its unique schedule identifier from the ReportCaster repository.
deleteSchedule(String) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
deleteSchedule(Authenticate, String) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
deleteSchedule(Authenticate, String) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
deleteUser(String, int) - Method in interface ibi.broker.api.cci.UserManager
Deletes the specified user, identified by the passed username, from the underlying database or repository using one of the three provided deletion methods.
deleteUser(String, int) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
deleteUser(Authenticate, String, int) - Method in interface ibi.broker.api.ws.UserManagerIF
 
deleteUser(Authenticate, String, int) - Method in class ibi.broker.api.ws.UserManagerWS
 
deleteUserFromGroup(String, String) - Method in interface ibi.broker.api.cci.UserManager
Deletes a user as identified by its ReportCaster userName from the specified groupName.
deleteUserFromGroup(String, String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
deleteUserFromGroup(Authenticate, String, String) - Method in interface ibi.broker.api.ws.UserManagerIF
 
deleteUserFromGroup(Authenticate, String, String) - Method in class ibi.broker.api.ws.UserManagerWS
 
deleteVersion(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Deletes the version of this report from the underlying report library database.
deleteVersion(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
deleteVersion(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
deleteVersion(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
deleteWatchItem(WatchItem) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
deleteWatchItem(WatchItem) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
deleteWatchItem(Authenticate, WatchItem) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
deleteWatchItem(Authenticate, WatchItem) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
description - Variable in class ibi.broker.api.data.schedule.Distribution
 
description - Variable in class ibi.broker.api.data.schedule.Notification
 
description - Variable in class ibi.broker.api.data.schedule.Task
 
description - Variable in class ibi.broker.api.data.schedule.TimeInfo
 
Destination - Class in ibi.broker.api.data.schedule
When ReportCaster distributes a schedule it determines the recipient(s) by accessing the members of a "destination container".
Destination() - Constructor for class ibi.broker.api.data.schedule.Destination
 
DestinationElement - Class in ibi.broker.api.data.addrbook
The DestinationElement class specifies destination locations and burst values.
DestinationElement() - Constructor for class ibi.broker.api.data.addrbook.DestinationElement
Default Constructor of DestinationElement
DFIX_DELIMITER - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
DHTML - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format DHTML.
Distribution - Class in ibi.broker.api.data.schedule
Distribution is an abstract class from which classes representing the ReportCaster distribution methods are derived.
Distribution() - Constructor for class ibi.broker.api.data.schedule.Distribution
 
DISTRIBUTION_FILE - Static variable in class ibi.broker.api.data.schedule.Destination
Destination type indicating distribution file.
DISTRIBUTION_LIST - Static variable in class ibi.broker.api.data.schedule.Destination
Destination type indicating distribution list.
DistributionEmail - Class in ibi.broker.api.data.schedule
Extends the abstract Distribution class, and is used when the distribution method for the scheduled ReportCaster job is Email.
DistributionEmail() - Constructor for class ibi.broker.api.data.schedule.DistributionEmail
 
DistributionFTP - Class in ibi.broker.api.data.schedule
The DistributionFTP class extends the abstract Distribution class where the distribution method for the scheduled ReportCaster report is via FTP.
DistributionFTP() - Constructor for class ibi.broker.api.data.schedule.DistributionFTP
 
DistributionPrint - Class in ibi.broker.api.data.schedule
Print distribution is one of five distribution types supported by ReportCaster.
DistributionPrint() - Constructor for class ibi.broker.api.data.schedule.DistributionPrint
 
DistributionSFTP - Class in ibi.broker.api.data.schedule
The DistributionSFTP class extends the DistributionFTP class where the distribution method for the scheduled ReportCaster report is SSH (Secure Shell) File Transfer Protocol.
DistributionSFTP() - Constructor for class ibi.broker.api.data.schedule.DistributionSFTP
 
DOC - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format DOC.
DsLog - Class in ibi.broker.api.data.dslog
When a scheduled report distribution job is run on the Distribution Server, the log of all activity relating to this process is encapsulated by way of the DsLog and DsLogElement classes.
DsLog() - Constructor for class ibi.broker.api.data.dslog.DsLog
 
DsLogElement - Class in ibi.broker.api.data.dslog
When a scheduled report distribution job is run on the Distribution Server, the record or log of all activity relating to this process is represented by way of the DsLog and DsLogElement classes, and stored in the ReportCaster Repository.
DsLogElement() - Constructor for class ibi.broker.api.data.dslog.DsLogElement
 
DYNAMIC_ADDRESS - Static variable in class ibi.broker.api.data.schedule.Destination
Destination type indicating dynamic address.
DynamicAddress - Class in ibi.broker.api.data.schedule
The DynamicAddress class is used when a ReportCaster distribution list is created dynamically at runtime.
DynamicAddress() - Constructor for class ibi.broker.api.data.schedule.DynamicAddress
 

E

EMAIL - Static variable in class ibi.broker.api.data.schedule.Distribution
Distribution method indicating the distribution of a scheduled report via EMAIL.
enabled - Variable in class ibi.broker.api.data.schedule.Distribution
 
enabled - Variable in class ibi.broker.api.data.schedule.Task
 
equals(Object) - Method in class ibi.broker.api.data.addrbook.AddrBook
 
equals(Object) - Method in class ibi.broker.api.data.addrbook.DestinationElement
 
equals(Object) - Method in class ibi.broker.api.data.library.Category
 
ERROR_FATAL - Static variable in class ibi.broker.api.data.dslog.DsLog
One of the three types of errors (errorType) produced during the process of logging a scheduled report distribution run.
ERROR_NO - Static variable in class ibi.broker.api.data.dslog.DsLog
One of the three types of errors (errorType) produced during the process of logging a scheduled report distribution run.
ERROR_WARNING - Static variable in class ibi.broker.api.data.dslog.DsLog
One of the three types of errors (errorType) produced during the process of logging a scheduled report distribution run.
EXCEL - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format EXCEL.
EXCEL_TEMPLATE - Static variable in class ibi.broker.api.data.library.Version
This is one of the valid values of the property format.
EXCEL_TEMPLATE - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format EXLEL TEMPLATE.
ExecId - Class in ibi.broker.api.data.user
 
ExecId() - Constructor for class ibi.broker.api.data.user.ExecId
 
ExecId(String, String, String) - Constructor for class ibi.broker.api.data.user.ExecId
 
EXL07 - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
EXL07_TEMPLATE - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
EXL2K - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format EXL2K.
EXL2K_FORMULA - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format EXL2K FORMULA.
EXL2K_PIVOT - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
EXL2K_PIVOT - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format EXL2K PIVOT.
EXL97 - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format EXL97.
EXPIREMODE_DAY - Static variable in class ibi.broker.api.data.library.Content
String constant representing library expiration based upon the number of days.
EXPIREMODE_HOUR - Static variable in class ibi.broker.api.data.library.Content
This expiration mode is for future use and is not currently implemented.
EXPIREMODE_MONTH - Static variable in class ibi.broker.api.data.library.Content
String constant representing a library expiration based upon a number of months.
EXPIREMODE_NEVER - Static variable in class ibi.broker.api.data.library.Content
String constant representing expiration mode of NEVER.
EXPIREMODE_VERSION - Static variable in class ibi.broker.api.data.library.Content
String constant representing a "version" type of library expiration.
EXPIREMODE_WEEK - Static variable in class ibi.broker.api.data.library.Content
String constant representing a library expiration based upon a number of weeks.
EXPIREMODE_YEAR - Static variable in class ibi.broker.api.data.library.Content
String constant representing a library expiration based upon a number of years.

F

FILE - Static variable in class ibi.broker.api.data.schedule.Task
Task type indicating a File task.
FILE - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
FLEX - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
FORMAT_ALPHA - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_COM - Static variable in class ibi.broker.api.data.library.Version
 
FORMAT_COMMA - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_COMT - Static variable in class ibi.broker.api.data.library.Version
This is one of the valid values of the property format.
FORMAT_DOC - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_EXCEL - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_EXL2K - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_EXL2K_FORMULA - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_EXL97 - Static variable in class ibi.broker.api.data.library.Version
This is one of the valid values of the property format.
FORMAT_GIF - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_HTML - Static variable in class ibi.broker.api.data.library.Version
This is one of the valid values of the property format.
FORMAT_PDF - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_PPT - Static variable in class ibi.broker.api.data.library.Version
 
FORMAT_PPTX - Static variable in class ibi.broker.api.data.library.Version
 
FORMAT_PS - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_TABT - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_WK1 - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_WP - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FORMAT_XML - Static variable in class ibi.broker.api.data.library.Version
String constant representing one of the valid formats for versions of content in the Report Library.
FTP - Static variable in class ibi.broker.api.data.schedule.Distribution
Distribution method indicating the distribution of a scheduled report via FTP.
FTP - Static variable in class ibi.broker.api.data.schedule.Task
 
FTP - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
FULLFUNCTION_MODE - Static variable in class ibi.broker.api.CasterManagedConnectionFactory
 

G

getAccess() - Method in class ibi.broker.api.data.addrbook.AddrBook
Returns the security setting of an Address Book.
getAccessElementList() - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Returns an Array of AccessElements.
getAccessibleCategoryInfoList(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Returns a Category list which can be accessible by the user owner.
getAccessibleCategoryInfoList(String, String, String) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getAccessibleCategoryInfoList(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getAccessibleCategoryInfoListByCaller() - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves an array of Category objects that are accessible to the authenticated user.
getAccessibleCategoryInfoListByCaller() - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getAccessibleCategoryInfoListByCaller(Authenticate) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getAccessibleCategoryInfoListByCaller(Authenticate) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getAccessibleContentInfo(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves a Content object as identified by the contentId.
getAccessibleContentInfo(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getAccessibleContentInfo(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getAccessibleContentInfo(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getAccessibleContentInfoList(String, Category) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves value of the designated category as a Content[] object without versionList.
getAccessibleContentInfoList(String, Category, boolean) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getAccessibleContentInfoList(String, String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves value of the designated report as a Content[] object without versionList.
getAccessibleContentInfoList(String, String, boolean) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getAccessibleContentInfoList(String, String, String, boolean) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getAccessibleContentInfoList(String, Category) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getAccessibleContentInfoList(Authenticate, String, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getAccessibleContentInfoList(Authenticate, String, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getAccessibleContentInfoListByCaller(Category) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves an array of all Content objects accessible by the authenticated user and associated with the given Category.
getAccessibleContentInfoListByCaller(Category) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getAccessibleContentInfoListByCaller(Authenticate, Category) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getAccessibleContentInfoListByCaller(Authenticate, Category) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getAccessibleReportList(String, String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Returns all accessible Standard Report and My Report file names in ReportLibrary with the given Managed Reporting Domain HREF and Folder HREF for the authenticated user.
getAccessibleReportList(Authenticate, String, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getAccessibleReportList(Authenticate, String, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getAccessibleVersion(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Returns an InputStream containing the report identified by the versionId.
getAccessibleVersion(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getAccessibleVersion(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getAccessibleVersion(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getAccessibleVersionInfo(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves a Version object as identified by the versionId.
getAccessibleVersionInfo(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getAccessibleVersionInfo(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getAccessibleVersionInfo(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getAccessList() - Method in class ibi.broker.api.data.library.Content
Obtains the name of the Access List, which is a list of users that have access to this content in the report library.
getAccessList() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Obtains the name of the access list associated with this report distribution to the library.
getAccessType() - Method in class ibi.broker.api.data.library.Content
Obtains one of the three access options (i.e., "access types") as a String constant.
getAccessType() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Obtains the String constant representing the access type for this library distribution.
getAction() - Method in class ibi.broker.scheduler.plugin.JobEvent
 
getAdapterName() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Obtains a name for the resource adapter.
getAdapterShortDescription() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Gets a tool displayable short description of the resource adapter.
getAdapterVendorName() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Obtains the name of the vendor that has provided the resource adapter implementation.
getAdapterVersion() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Obtains the version of the resource adapter.
getAddress() - Method in class ibi.broker.api.data.user.User
Returns the user's e-mail address.
getAddressBook(String) - Method in interface ibi.broker.api.cci.AddressBookManager
Returns an AddrBook object specified by bookName.
getAddressBook(String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBook(Authenticate, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getAddressBook(Authenticate, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getAddressBookManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains an instance of ibi.broker.api.cci.AddressBookManager that is to be used in conjunction with this connection instance.
getAddressBookPrivateList(String) - Method in interface ibi.broker.api.cci.AddressBookManager
 
getAddressBookPrivateList(String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBookPrivateListByCaller(String) - Method in interface ibi.broker.api.cci.AddressBookManager
Returns an Array of PRIVATE AddrBook objects for both the given distribution method and the caller who has authenticated.
getAddressBookPrivateListByCaller(String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBookPrivateListByCaller(Authenticate, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getAddressBookPrivateListByCaller(Authenticate, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getAddressBookPrivateListByOwner(String, String) - Method in interface ibi.broker.api.cci.AddressBookManager
Returns an Array of PRIVATE AddrBook objects for a given distribution method and the specified owner of the AddrBooks.
getAddressBookPrivateListByOwner(String, String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBookPrivateListByOwner(Authenticate, String, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getAddressBookPrivateListByOwner(Authenticate, String, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getAddressBookProperty(String) - Method in interface ibi.broker.api.cci.AddressBookManager
Returns an AddrBook object specified by bookName.
getAddressBookProperty(String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBookProperty(Authenticate, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getAddressBookProperty(Authenticate, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getAddressBookPublicList(String) - Method in interface ibi.broker.api.cci.AddressBookManager
Returns an Array of PUBLIC AddrBook objects for a given distribution method.
getAddressBookPublicList(String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBookPublicList(Authenticate, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getAddressBookPublicList(Authenticate, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getAddressBookPublicListByCaller(String) - Method in interface ibi.broker.api.cci.AddressBookManager
Returns an Array of PUBLIC AddrBook objects for a given distribution method and the caller who has authenticated.
getAddressBookPublicListByCaller(String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBookPublicListByCaller(Authenticate, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getAddressBookPublicListByCaller(Authenticate, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getAddressBookPublicListByOwner(String, String) - Method in interface ibi.broker.api.cci.AddressBookManager
Returns an Array of PUBLIC AddrBook objects for a given distribution method and the specified owner of the Address Books.
getAddressBookPublicListByOwner(String, String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getAddressBookPublicListByOwner(Authenticate, String, String) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getAddressBookPublicListByOwner(Authenticate, String, String) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getAddressForBriefNotification() - Method in class ibi.broker.api.data.schedule.Notification
Obtains the e-mail address indicating where a brief notification message will be sent after running a schedule in ReportCaster.
getAddressForFullNotification() - Method in class ibi.broker.api.data.schedule.Notification
Obtains the e-mail address where a full notification message will be sent after running a schedule in ReportCaster.
getAlert() - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Obtains the Alert object associated with this task.
getAllowFormatList() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
getAmperParameter() - Method in class ibi.broker.api.data.schedule.Parameter
 
getAmperParameterList(Task) - Method in interface ibi.broker.api.cci.ScheduleManager
Deprecated. 
getAmperParameterList(Task, String) - Method in interface ibi.broker.api.cci.ScheduleManager
Obtains an Array of AmperParameter objects that are associated with a scheduled task.
getAmperParameterList(Task) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getAmperParameterList(Task, String) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getAmperParameterList(Authenticate, Task) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
getAmperParameterList(Authenticate, Task) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getAnnotationManager() - Method in class ibi.broker.api.cci.CasterConnection
 
getApplicationPreference() - Method in class ibi.broker.api.cci.CasterConnection
 
getApplicationPreferenceList() - Method in interface ibi.broker.api.cci.ConfigManager
 
getArgumentList() - Method in exception ibi.broker.api.data.CasterException
 
getBlackoutDateList(String) - Method in interface ibi.broker.api.cci.ConfigManager
 
getBookName() - Method in class ibi.broker.api.data.addrbook.AddrBook
Returns the name of an Address Book.
getBurstValue() - Method in class ibi.broker.api.data.addrbook.DestinationElement
Returns the burst value associated with this DestinationElement.
getBurstValue() - Method in class ibi.broker.api.data.library.Content
Obtains the burst value associated with this library report distribution.
getBurstValue() - Method in class ibi.broker.api.data.libraryaccess.AccessElement
Returns the burst value for a scheduled job.
getCategory() - Method in class ibi.broker.api.data.library.Content
 
getCategory() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Obtains the library category associated with this report.
getCategoryInfoList() - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves an array of Category objects.
getCategoryInfoList() - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getCategoryInfoList(Authenticate) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getCategoryInfoList(Authenticate) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getCategoryInfoListByOwner(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves an array of Category objects associated with a given ReportCaster user.
getCategoryInfoListByOwner(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getCategoryInfoListByOwner(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getCategoryInfoListByOwner(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getCompressFormat() - Method in class ibi.broker.api.data.library.Version
 
getCompressSize() - Method in class ibi.broker.api.data.library.Version
 
getConfigManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains an instance of ibi.broker.api.cci.ConfigManager that is to be used in conjunction with this connection instance.
getConfigPath() - Method in class ibi.broker.api.CasterManagedConnectionFactoryMigration
 
getConnection() - Method in class ibi.broker.api.cci.CasterConnectionFactory
Obtains a CasterConnection instance of the connection handle to satisfy a connection request for the current user.
getConnection(ConnectionSpec) - Method in class ibi.broker.api.cci.CasterConnectionFactory
Obtains a CasterConnection instance of the connection handle to satisfy a connection request from the user identified in the ConnectionSpec.
getConnection(ConnectionSpec, boolean, boolean) - Method in class ibi.broker.api.cci.CasterConnectionFactory
 
getConsoleManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains an instance of ibi.broker.api.cci.ConsoleManager that is to be used in conjunction with this connection instance.
getContent(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves the Content object as identified by the contentId key field.
getContent(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getContent(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getContent(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getContentId(String, String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Obtains the content identifier associated with a designated owner and a given content description string.
getContentId() - Method in class ibi.broker.api.data.library.WatchItem
 
getContentId(String, String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getContentId(Authenticate, String, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getContentId(Authenticate, String, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getContentInfoList(Category) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves an array of Content objects associated with the given Category.
getContentInfoList(Category, boolean) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getContentInfoList(Category) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getContentInfoList(Authenticate, Category) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getContentInfoList(Authenticate, Category) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getContentInfoListByCaller(Category) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves an array of Content objects identified with the given Category and owned by the current authenticated user.
getContentInfoListByCaller(Category) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getContentInfoListByCaller(Authenticate, Category) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getContentInfoListByCaller(Authenticate, Category) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getContentInfoListByOwner(String, Category) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves an array of Content objects owned by the specified ReportCaster userid within the specified Category.
getContentInfoListByOwner(String, Category) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getContentInfoListByOwner(Authenticate, String, Category) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getContentInfoListByOwner(Authenticate, String, Category) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getContentList() - Method in class ibi.broker.api.data.library.Category
Obtains an Array of report library Content objects that are nested into this category.As the category is the parent of content in the hierarchical scheme, the content list provides access to the actual content for a given instance of category.
getCreateDate() - Method in class ibi.broker.api.data.library.Version
Obtains the creation date for this version of Report Library content.
getDatabasePassword() - Method in interface ibi.broker.scheduler.plugin.DBLocatorExit
 
getDatabaseURL() - Method in interface ibi.broker.scheduler.plugin.DBLocatorExit
 
getDatabaseUser() - Method in interface ibi.broker.scheduler.plugin.DBLocatorExit
 
getDateList() - Method in class ibi.broker.api.data.schedule.TimeInfoCustom
 
getDayOfWeek() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
getDaysOfMonth() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Obtains a 31 element array of booleans indicating which days of the month have been selected for a report to run.
getDefaultValue() - Method in class ibi.broker.api.data.schedule.AmperParameter
getDefaultValue() obtains the default value that has been assigned to the parameter defined within the FOCUS procedure.
getDescription() - Method in class ibi.broker.api.data.library.Content
Obtains a string describing this scheduled distribution of report library content.
getDescription() - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Returns the description of an Access List.
getDescription() - Method in class ibi.broker.api.data.schedule.Distribution
 
getDescription() - Method in class ibi.broker.api.data.schedule.Notification
 
getDescription() - Method in class ibi.broker.api.data.schedule.OptionValue
Obtains the text used to describe what the option value is.
getDescription() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the text describing the job that is being scheduled.
getDescription() - Method in class ibi.broker.api.data.schedule.Task
Obtains the text used to describe the task.
getDescription() - Method in class ibi.broker.api.data.schedule.TimeInfo
 
getDescription() - Method in class ibi.broker.api.data.user.Group
Obtains the description of the ReportCaster Group.
getDescription() - Method in class ibi.broker.api.data.user.User
Returns the description of the user.
getDestination() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains a destination object, which contains the information indicating where the scheduled report will be distributed.
getDestination() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the destination object, which contains information indicating where the scheduled report will be distributed.
getDestination() - Method in class ibi.broker.api.data.schedule.DistributionPrint
Throws the destination object, which contains information indicating the target(s) of distribution.
getDestinationList() - Method in class ibi.broker.api.data.addrbook.AddrBook
Returns an Array of DestinationElements where each includes a destination and a burst value.
getDistribution() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the Distribution object associated with this Schedule.
getDistributionFile() - Method in class ibi.broker.api.data.schedule.Destination
Obtains the fully qualified path to the distribution file associated with this Destination object.
getDistributionList() - Method in class ibi.broker.api.data.schedule.Destination
This method obtains the distribution list associated with this Destination object.
getDistributionServerName() - Method in class ibi.broker.api.data.console.Job
 
getDomainHREF() - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Obtains the value of the domain that is a part of the URI that references the Standard Report on the Managed Report Server.
getDserverManager() - Method in class ibi.broker.api.cci.CasterConnection
 
getDsLog() - Method in class ibi.broker.api.data.console.JobStatus
 
getDsLog() - Method in class ibi.broker.scheduler.plugin.JobEvent
 
getDuration() - Method in class ibi.broker.api.data.schedule.TimeInterval
Obtains the duration of a scheduled event, in minutes.
getDynamicAddress() - Method in class ibi.broker.api.data.schedule.Destination
Obtains the DynamicAddress object associated with this Destination object.
getEISProductName() - Method in class ibi.broker.api.cci.CasterConnectionMetaData
Returns product name of the underlying EIS instance connected through the Connection object that produced this metadata.
getEISProductVersion() - Method in class ibi.broker.api.cci.CasterConnectionMetaData
Returns product name of the underlying EIS instance connected through the Connection object that produced this metadata.
getEndTime() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains the Calendar time when the schedule job run ends.
getEndTime() - Method in class ibi.broker.api.data.schedule.TimeInfoCustom
 
getEndTime() - Method in class ibi.broker.api.data.schedule.TimeInfoDay
Obtains a Java Calendar Object indicating the end time for a scheduled event.
getEndTime() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a Java Calendar Object indicating the end time for a ReportCaster schedule.
getEndTime() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Obtains a Java Calendar Object indicating the end time for the schedule associated with the this TimeInfoMonth instance.
getErrorCode() - Method in exception ibi.broker.api.data.CasterException
Obtains the error code for this CasterException.
getErrorType() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains a String constant indicating the type of error that may have occurred during the scheduled report distribution job run.
getExecId() - Method in class ibi.broker.api.data.dslog.DsLogElement
Obtains the execution ID associated with this instance of DslogElement.
getExecId() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the user name needed to establish a connection to the WebFOCUS Reporting Server.
getExecIdInfoList(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getExecIdListByServerByOwner(String, User, String) - Method in interface ibi.broker.api.cci.UserManager
 
getExecIdListByServerByOwner(String, User, String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getExecIdOwnerList() - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getExecPassword() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the password needed to establish a connection to the WebFOCUS Reporting Server.
getExpirationData() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Obtains the expiration data used to calculate the expiration of a Library resident report.
getExpirationMode() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Obtains the expiration mode as a String constant.
getExpireDate() - Method in class ibi.broker.api.data.library.Version
Obtains the expiration date for this version of Report Library content.
getExpireInterval() - Method in class ibi.broker.api.data.library.Content
Obtains the expiration interval of report content distributed to the report library.
getExpireMode() - Method in class ibi.broker.api.data.library.Content
Obtains the expiration mode for the report library content.
getFileName() - Method in class ibi.broker.api.data.schedule.TaskFile
Obtains the name of the file to be scheduled for distribution by ReportCaster.
getFileName() - Method in class ibi.broker.api.data.schedule.TaskFtp
Obtains the name of the file to be scheduled for distribution by ReportCaster.
getFirstPostProcessingProcedure() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the name of the first of two possible post-processing procedures that can be associated with this WebFOCUS Server procedure task.
getFirstPreProcessingProcedure() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the name of the first of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task.
getFirstTask() - Method in class ibi.broker.api.data.schedule.Schedule
 
getFolderHREF() - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Obtains the value of the folder that is a part of the URI that references the Standard Report on the Managed Report Server.
getFolderName() - Method in class ibi.broker.api.data.schedule.StorageMre
Obtains the name of the folder to which you are sending a report for scheduled distribution to Managed Reporting.
getFormat() - Method in class ibi.broker.api.data.library.Version
Obtains the format of this version of Report Library content as a String constant.
getFormat() - Method in class ibi.broker.api.data.schedule.AmperParameter
 
getFrequency() - Method in class ibi.broker.api.data.schedule.TimeInfoDay
Obtains the frequency for a scheduled event, in days.
getFrequency() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains the frequency of a ReportCaster schedule as an integer, in minutes.
getFrequency() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Obtains the frequency for a scheduled distribution.
getFrom() - Method in class ibi.broker.api.data.schedule.Notification
Obtains the e-mail address linked to the From header to which notification will be sent upon running a schedule in ReportCaster.
getFtpLocation() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the virtual directory for a report scheduled for distribution via FTP.
getFtpPassword() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the password to the target FTP server needed to authenticate at the time of report distribution.
getFtpServerName() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the name of the FTP server that is the target of the distribution.
getFtpUserName() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the username needed to authenticate to the target FTP server at the time of report distribution.
getFullyQualifiedServerName() - Method in class ibi.broker.api.data.console.Job
 
getGlobalBlackoutDateList() - Method in interface ibi.broker.api.cci.ConfigManager
 
getGroup(String) - Method in interface ibi.broker.api.cci.UserManager
Retrieves a Group object as identified by its groupName from the underlying database orrepository.
getGroup(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getGroup(Authenticate, String) - Method in interface ibi.broker.api.ws.UserManagerIF
 
getGroup(Authenticate, String) - Method in class ibi.broker.api.ws.UserManagerWS
 
getGroupList() - Method in interface ibi.broker.api.cci.UserManager
Retrieves an array of Group objects representing a list of all groups to which the current user belongs.
getGroupList() - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getGroupList(Authenticate) - Method in interface ibi.broker.api.ws.UserManagerIF
 
getGroupList(Authenticate) - Method in class ibi.broker.api.ws.UserManagerWS
 
getGroupListByUserName(String) - Method in interface ibi.broker.api.cci.UserManager
 
getGroupListByUserName(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getGroupNameListByUser(String) - Method in interface ibi.broker.api.cci.UserManager
Retrieves a string array representing a list of all group names where a specific ReportCaster user belongs to or is a member of these group names.
getGroupNameListByUser(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getGroupNameListByUser(Authenticate, String) - Method in interface ibi.broker.api.ws.UserManagerIF
 
getGroupNameListByUser(Authenticate, String) - Method in class ibi.broker.api.ws.UserManagerWS
 
getId() - Method in class ibi.broker.api.data.console.Job
Obtains a String identifier associated with this Job on the ReportCaster Console.
getId() - Method in class ibi.broker.api.data.library.WatchItem
 
getId() - Method in class ibi.broker.api.data.schedule.Distribution
 
getId() - Method in class ibi.broker.api.data.schedule.Notification
 
getId() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the unique identifier to this schedule, also known as a scheduleID.
getId() - Method in class ibi.broker.api.data.schedule.Task
Obtains the unique identifier ReportCaster generates for every saved task.
getId() - Method in class ibi.broker.api.data.schedule.TimeInfo
 
getId() - Method in class ibi.broker.api.data.user.Group
 
getIndexFile() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the index file associated with report(s) scheduled for distribution via FTP where bursting is activated.
getInlineMessage() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains the inline message associated with an e-mail report distribution.
getInlineTaskIndex() - Method in class ibi.broker.api.data.schedule.DistributionEmail
This method returns the task index of the report that is going to be inline (in the body of the email).ReportCaster schedules can accept multiple tasks, with each task representing a report within the schedule.
getInMemoryLogWithJobNumber(String, String) - Method in interface ibi.broker.api.cci.ConsoleManager
 
getInteractionSpecsSupported() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Not currently supported.
getInterval() - Method in class ibi.broker.api.data.schedule.TimeInterval
Obtains the interval for a scheduled event, in minutes.
getJob() - Method in class ibi.broker.scheduler.plugin.JobEvent
 
getJobCounterStack(String) - Method in interface ibi.broker.api.cci.ConsoleManager
 
getJobId() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains a unique identifier to the log or record of the Distribution Server job.
getJobListenerClassName() - Method in class ibi.broker.api.data.console.JobOptions
 
getJobsInQueue() - Method in interface ibi.broker.api.cci.ConsoleManager
Retrieves an Array of all Jobs that are currently on queue to run on the Distribution Server.
getJobsInQueue() - Method in class ibi.broker.api.ws.ConsoleManagerClientSF
 
getJobsInQueue(Authenticate) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getJobsInQueue(Authenticate) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getJobsInQueueByOwner(String) - Method in interface ibi.broker.api.cci.ConsoleManager
Retrieves an Array of Jobs having a specified owner that are currently on queue to run on the Distribution Server.
getJobsInQueueByOwner(Authenticate, String) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getJobsInQueueByOwner(Authenticate, String) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getJobsInQueueByOwnerByServer(String, String) - Method in interface ibi.broker.api.cci.ConsoleManager
 
getJobsInQueueByOwnerByServer(Authenticate, String, String) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getJobsInQueueByOwnerByServer(Authenticate, String, String) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getJobStatus(String) - Method in interface ibi.broker.api.cci.ConsoleManager
 
getJobStatus(Authenticate, String) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getJobStatus(Authenticate, String) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getJobstatusNotFound() - Static method in class ibi.broker.api.data.console.JobStatus
 
getJobStatusStack(String) - Method in interface ibi.broker.api.cci.ConsoleManager
 
getLastExecTime() - Method in class ibi.broker.api.data.library.Content
 
getLastLogByScheduleId(String) - Method in interface ibi.broker.api.cci.LogManager
Retrieves a DsLog object, the components of which are taken from the ReportCaster repository as identified by the specified scheduleId (see Schedule.getId()).
getLastLogByScheduleId(String) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
getLastLogByScheduleId(Authenticate, String) - Method in interface ibi.broker.api.ws.LogManagerIF
 
getLastLogByScheduleId(Authenticate, String) - Method in class ibi.broker.api.ws.LogManagerWS
 
getLastTimeExecuted() - Method in class ibi.broker.api.data.schedule.Schedule
 
getLastVersion() - Method in class ibi.broker.api.data.library.Content
 
getLatestAccessibleContent(Schedule) - Method in interface ibi.broker.api.cci.LibraryContentManager
Obtains the Content object that has latest version data and is accessible to the authenticated user and associated with the given Schedule object.
getLatestAccessibleContent(Schedule) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getLatestAccessibleContent(Authenticate, Schedule) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getLatestAccessibleContent(Authenticate, Schedule) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getLibraryAccessBook(String) - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
getLibraryAccessBook(String) - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
getLibraryAccessBook(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryAccessManagerIF
 
getLibraryAccessBook(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
getLibraryAccessBookInfoList() - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
getLibraryAccessBookInfoList() - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
getLibraryAccessBookInfoList(Authenticate) - Method in interface ibi.broker.api.ws.LibraryAccessManagerIF
 
getLibraryAccessBookInfoList(Authenticate) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
getLibraryAccessBookInfoListByOwner(String) - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
getLibraryAccessBookInfoListByOwner(String) - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
getLibraryAccessBookInfoListByOwner(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryAccessManagerIF
 
getLibraryAccessBookInfoListByOwner(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
getLibraryAccessManager() - Method in class ibi.broker.api.cci.CasterConnection
 
getLibraryContentManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains an instance of ibi.broker.api.cci.LibraryContentManager that is to be used in conjunction with this connection instance.
getLibraryURL() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
getLibraryURL() - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Obtains the base URL contained in a library email notification.
getLocalTransaction() - Method in class ibi.broker.api.cci.CasterConnection
This method is currently not available for use within the API.
getLocation() - Method in class ibi.broker.api.data.addrbook.DestinationElement
Returns a destination location representing a single destination in an address book.
getLogByJobId(String) - Method in interface ibi.broker.api.cci.LogManager
Retrieves a DsLog object, the components of which are taken from the underlying ReportCaster repository as identified by the specified jobId.
getLogByJobId(String) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
getLogByJobId(Authenticate, String) - Method in interface ibi.broker.api.ws.LogManagerIF
 
getLogByJobId(Authenticate, String) - Method in class ibi.broker.api.ws.LogManagerWS
 
getLogElementList() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains the Array of(DsLogElement[]) objects that are associated with this instance of the DsLog class.
getLogInfoListByOwner(String) - Method in interface ibi.broker.api.cci.LogManager
Retrieves an Array of partially setDslog objects for a specified owner (ie, logs of all schedule runs for a designated owner).
getLogInfoListByOwner(String) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
getLogInfoListByOwner(Authenticate, String) - Method in interface ibi.broker.api.ws.LogManagerIF
 
getLogInfoListByOwner(Authenticate, String) - Method in class ibi.broker.api.ws.LogManagerWS
 
getLogInfoListByOwnerByCalendar(String, Calendar, Calendar) - Method in interface ibi.broker.api.cci.LogManager
Retrieves an Array of partially set Dslog objects with a specified owner (ie, logs of all schedule runs for a designated owner), where the jobs were run during a specified time interval (delineated by startTime and endTime).
getLogInfoListByOwnerByCalendar(String, Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
getLogInfoListByOwnerByCalendar(Authenticate, String, Calendar, Calendar) - Method in interface ibi.broker.api.ws.LogManagerIF
 
getLogInfoListByOwnerByCalendar(Authenticate, String, Calendar, Calendar) - Method in class ibi.broker.api.ws.LogManagerWS
 
getLogInfoListByScheduleId(String) - Method in interface ibi.broker.api.cci.LogManager
Retrieves an Array of partially set Dslog objects for a specified scheduleId (ie, logs for all the runs of a designated schedule).
getLogInfoListByScheduleId(String) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
getLogInfoListByScheduleId(Authenticate, String) - Method in interface ibi.broker.api.ws.LogManagerIF
 
getLogInfoListByScheduleId(Authenticate, String) - Method in class ibi.broker.api.ws.LogManagerWS
 
getLogListByScheduleId(String) - Method in interface ibi.broker.api.cci.LogManager
 
getLogListByScheduleId(String) - Method in class ibi.broker.api.ws.LogManagerClientSF
 
getLogManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains an instance of ibi.broker.api.cci.LogManager that is to be used in conjunction with this connection instance.
getLogWriter() - Method in class ibi.broker.api.CasterManagedConnectionFactory
Obtains the log writer for this CasterManagedConnectionFactory instance.
getLogWriter() - Method in class ibi.broker.api.cci.CasterConnection
 
getMailFrom() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains the e-mail address associated with the From header field of a scheduled e-mail distribution.
getMailFrom() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
getMailFrom() - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Obtains the "From" email address in this Library email notification.
getMailMessage() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
getMailMessage() - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Obtains the email message content contained in the email message sent out as part of this notification email (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()).
getMailReplyAddress() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains the reply e-mail address from Reply Address header field of a scheduled e-mail distribution.
getMailReplyAddress() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
getMailReplyAddress() - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Obtains the "Reply" email address sent in this Library email notification.
getMailServerName() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains a SMTP mail server name associated with scheduled e-mail distribution.
getMailServerName() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
getMailServerName() - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Obtains the mail server name used to send this library email notification.
getMailSubject() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains an e-mail Subject corresponding to the Subject header field associated with scheduled e-mail distribution.
getMailSubject() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
getMailSubject() - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Obtains the email subject sent in this library email notification.
getMaximum() - Method in class ibi.broker.api.data.schedule.AmperParameter
 
getMemberName() - Method in class ibi.broker.api.data.libraryaccess.AccessElement
Returns members (clientIds) associated with a Library Access List.
getMemberType() - Method in class ibi.broker.api.data.libraryaccess.AccessElement
Returns the type associated with a member.
getMessage() - Method in exception ibi.broker.api.data.CasterException
Obtains the message text which describes this CasterException.
getMessage() - Method in class ibi.broker.api.data.dslog.DsLogElement
Obtains the log text describing exactly what takes place in the job execution process during this instance of DsSLogElement.
getMessage() - Method in exception ibi.broker.scheduler.plugin.SCHFieldNotFoundException
 
getMessageCode() - Method in class ibi.broker.api.data.dslog.DsLogElement
Obtains the message code as a String constant corresponding to this instance of DsLogElement.
getMetaData() - Method in class ibi.broker.api.cci.CasterConnection
Obtains information about the active connection to the ReportCaster repository, which is represented by this instance of CasterConnection.
getMetaData() - Method in class ibi.broker.api.cci.CasterConnectionFactory
Obtains metadata for the Resource Adapter.
getMethod() - Method in class ibi.broker.api.data.addrbook.AddrBook
Returns the distribution method for an Address Book.
getMinimum() - Method in class ibi.broker.api.data.schedule.AmperParameter
 
getMrManager(String) - Method in class ibi.broker.api.cci.CasterConnection
 
getMrRole() - Method in class ibi.broker.api.data.user.User
 
getName() - Method in class ibi.broker.api.data.library.Category
Obtains the name of the category under which report library content and their related version objects will be organized.
getName() - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Returns the unique name of an Access List.
getName() - Method in class ibi.broker.api.data.schedule.OptionValue
Obtains the name given to a particular option value.
getName() - Method in class ibi.broker.api.data.schedule.Parameter
Obtains the name of a parameter associated with a task scheduled for distribution within ReportCaster.
getName() - Method in class ibi.broker.api.data.schedule.TimeInfo
 
getName() - Method in class ibi.broker.api.data.user.ExecId
 
getName() - Method in class ibi.broker.api.data.user.Group
Returns the name of the Group.
getName() - Method in class ibi.broker.api.data.user.User
Returns the users login name, also known as the casterUser or ReportCaster ID.
getName() - Method in class ibi.broker.api.data.ValidationErrorItem
 
getNestedThrowable() - Method in exception ibi.broker.api.data.CasterException
Obtains the error that was the ultimate cause of this CasterException.
getNextRunTime() - Method in class ibi.broker.api.data.schedule.TimeInfo
Obtains a Java Calendar Object indicating the next run time for a scheduled event.
getNodeList() - Method in interface ibi.broker.api.cci.ConsoleManager
 
getNodeList(Authenticate) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getNodeList(Authenticate) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getNotification() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains an instance of the Notification object associated with this Schedule.
getOperation() - Method in class ibi.broker.api.data.schedule.AmperParameter
 
getOptionValueList() - Method in class ibi.broker.api.data.schedule.AmperParameter
Obtains an array of values, which represent the range of possible options that are valid for a particular instance of AmperParameter.
getOwner() - Method in class ibi.broker.api.data.addrbook.AddrBook
Returns the owner of an Address Book.
getOwner() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains the username of the schedule owner.
getOwner() - Method in class ibi.broker.api.data.library.Content
Obtains the owner of this scheduled distribution of content to the Report Library.
getOwner() - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Returns the ID of the owner of an Access List.
getOwner() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the ReportCaster owner of this schedule, which is a ReportCaster userid.
getOwner() - Method in class ibi.broker.api.data.user.ExecId
 
getOwnerList() - Method in interface ibi.broker.api.cci.AddressBookManager
Retrieves the Address Book owner list as a String Array from the ReportCaster Repository.
getOwnerList(String, String) - Method in interface ibi.broker.api.cci.AddressBookManager
 
getOwnerList() - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
getOwnerList() - Method in interface ibi.broker.api.cci.LibraryContentManager
Returns a list of library report owners.
getOwnerList() - Method in interface ibi.broker.api.cci.LogManager
Retrieves a String Array representing the schedule owner list from the ReportCaster repository.
getOwnerList() - Method in interface ibi.broker.api.cci.ScheduleManager
Retrieves a String Array representing the list of schedule owners from ReportCaster repository.
getOwnerList() - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getOwnerList(String, String) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
getOwnerList(Authenticate) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
getOwnerList(Authenticate) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
getOwnerList() - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
getOwnerList(Authenticate) - Method in interface ibi.broker.api.ws.LibraryAccessManagerIF
 
getOwnerList(Authenticate) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
getOwnerList() - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getOwnerList(Authenticate) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getOwnerList(Authenticate) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getOwnerList() - Method in class ibi.broker.api.ws.LogManagerClientSF
 
getOwnerList(Authenticate) - Method in interface ibi.broker.api.ws.LogManagerIF
 
getOwnerList(Authenticate) - Method in class ibi.broker.api.ws.LogManagerWS
 
getOwnerList() - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getOwnerList(Authenticate) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
getOwnerList(Authenticate) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getParameterDescription() - Method in class ibi.broker.api.data.schedule.AmperParameter
 
getParameterList() - Method in class ibi.broker.api.data.schedule.TaskUrl
Returns an array of Parameters objects associated with an instance of TaskURL.
getParameterList() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains an array of Parameter objects, with each object representing a name value pair that is matched and then resolved upon the execution of this WebFOCUS Server procedure.
getParameterName() - Method in class ibi.broker.api.data.schedule.AmperParameter
Returns the name of the parameter associated with an instance of AmperParameter.
getPassphrase(String, String, String) - Method in class ibi.broker.scheduler.plugin.DefaultSFTPSecurityExit
 
getPassphrase(String, String, String) - Method in interface ibi.broker.scheduler.plugin.SFTPSecurityExit
 
getPassword() - Method in class ibi.broker.api.cci.PasswordCredential
Returns the password as a character Array.
getPassword() - Method in class ibi.broker.api.data.Authenticate
Returns the password associated with this authenticate object.
getPassword() - Method in class ibi.broker.api.data.schedule.DynamicAddress
Returns the value of the password required for authentication to the reporting server containing the FOCUS Procedure that creates the dynamic distribution list.
getPassword() - Method in class ibi.broker.api.data.schedule.TaskFtp
Returns the password as a character Array.
getPassword() - Method in class ibi.broker.api.data.schedule.TaskUrl
Obtains the value of the password necessary to access the URL's Web server.
getPassword() - Method in class ibi.broker.api.data.user.ExecId
 
getPassword() - Method in class ibi.broker.api.data.user.User
Returns the password associated with user name.
getPassword(String, String) - Method in class ibi.broker.scheduler.plugin.SCHDomainBasedPassword
 
getPassword(String, String) - Method in interface ibi.broker.scheduler.plugin.SCHZipEncryptionPassword
 
getPasswordAuthentication(String, String, String) - Method in class ibi.broker.scheduler.plugin.DefaultSMTPSecurityExit
 
getPasswordAuthentication(String, String, String) - Method in interface ibi.broker.scheduler.plugin.SMTPSecurityExit
 
getPath() - Method in class ibi.broker.scheduler.plugin.SCHDomainBasedPassword
 
getPriority() - Method in class ibi.broker.api.data.console.JobOptions
 
getPriority() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the priority level for the scheduled job.
getProcedureDescription() - Method in class ibi.broker.api.data.schedule.TaskStandardReport
 
getProcedureName() - Method in class ibi.broker.api.data.schedule.DynamicAddress
Returns the name of the FOCUS Executable that produces the dynamic distribution list.
getProcedureName() - Method in class ibi.broker.api.data.schedule.Task
Obtains the name of the FOCUS executable procedure ("FOCEXEC") that resides on the reporting server associated with this task.
getProcedureName() - Method in class ibi.broker.api.data.schedule.TaskFile
 
getProcedureName() - Method in class ibi.broker.api.data.schedule.TaskFtp
 
getPropertyName() - Method in exception ibi.broker.api.data.CasterException
Obtains the name of the property associated with the class in which this CasterException was thrown.
getRecordFactory() - Method in class ibi.broker.api.cci.CasterConnectionFactory
Obtains a RecordFactory object, used to create generic Record instances.
getReference() - Method in class ibi.broker.api.cci.CasterConnectionFactory
Obtains the Reference instance.
getReportName() - Method in class ibi.broker.api.data.schedule.Task
Obtains the name of the report associated with this task.
getRequest() - Method in class ibi.broker.api.cci.WebAuthenticateCredential
Returns the HTTP Servlet request object.
getResetInterval() - Method in class ibi.broker.api.data.schedule.Alert
Obtains the time interval (delay) between when an alert schedule is run upon being triggered and when it is reactivated.
getResetType() - Method in class ibi.broker.api.data.schedule.Alert
Obtains reset type for an alert in the form of a String Constant.
getResultSetInfo() - Method in class ibi.broker.api.cci.CasterConnection
This method is currently not available for use within the API.
getRole() - Method in class ibi.broker.api.data.user.User
Returns a String constant indicating the user's ReportCaster role.
getRunningJobs() - Method in interface ibi.broker.api.cci.ConsoleManager
Retrieves an array of all Jobs that are currently running on the Distribution Server.
getRunningJobs() - Method in class ibi.broker.api.ws.ConsoleManagerClientSF
 
getRunningJobs(Authenticate) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getRunningJobs(Authenticate) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getRunningJobsByOwner(String) - Method in interface ibi.broker.api.cci.ConsoleManager
Retrieves an array of all Jobs that are currently running on the Distribution Server which belong to a specified owner.
getRunningJobsByOwner(Authenticate, String) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getRunningJobsByOwner(Authenticate, String) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getRunningJobsByOwnerByServer(String, String) - Method in interface ibi.broker.api.cci.ConsoleManager
 
getRunningJobsByOwnerByServer(Authenticate, String, String) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
getRunningJobsByOwnerByServer(Authenticate, String, String) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
getSchedule(String) - Method in interface ibi.broker.api.cci.ScheduleManager
Retrieves an existing schedule from the ReportCaster repository based on a given schedule identifier.
getSchedule() - Method in class ibi.broker.api.data.console.Job
Obtains the Schedule object being run on the Distribution Server associated with this Job.
getSchedule(String) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getSchedule(Authenticate, String) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
getSchedule(Authenticate, String) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getScheduleDescription() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains the text describing the Schedule that is being run and logged on the Distribution Server.
getScheduleId(String, String) - Method in interface ibi.broker.api.cci.ScheduleManager
Retrieves the unique schedule identifier from the ReportCaster repository based on specifying the schedule description (see Schedule.getDescription()) and owner.
getScheduleId() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains the unique identifier to the Schedule that is being run and logged on the Distribution Server.
getScheduleId() - Method in class ibi.broker.api.data.library.Content
 
getScheduleId() - Method in class ibi.broker.api.data.schedule.TaskSchedule
 
getScheduleId(String, String) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getScheduleId(Authenticate, String, String) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
getScheduleId(Authenticate, String, String) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getScheduleInfoList(String, String, String, String, Calendar, Calendar) - Method in interface ibi.broker.api.cci.ScheduleManager
 
getScheduleInfoList(String[]) - Method in interface ibi.broker.api.cci.ScheduleManager
 
getScheduleInfoList(String[]) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getScheduleInfoList(String, String, String, String, Calendar, Calendar) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getScheduleInfoList(Authenticate, String[]) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getScheduleInfoListByCaller() - Method in interface ibi.broker.api.cci.ScheduleManager
Retrieves an array of Schedule objects from the ReportCaster repository that are owned by the current logon user (or API caller).
getScheduleInfoListByCaller() - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getScheduleInfoListByCaller(Authenticate) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
getScheduleInfoListByCaller(Authenticate) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getScheduleInfoListByOwner(String) - Method in interface ibi.broker.api.cci.ScheduleManager
Retrieves an array of Schedule objects from the ReportCaster repository that belong to a specified owner.
getScheduleInfoListByOwner(String) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getScheduleInfoListByOwner(Authenticate, String) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
getScheduleInfoListByOwner(Authenticate, String) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getScheduleList(String[]) - Method in interface ibi.broker.api.cci.ScheduleManager
 
getScheduleList(String[]) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
getScheduleList(Authenticate, String[]) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
getScheduleManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains an instance of ibi.broker.api.cci.ScheduleManager that is to be used in conjunction with this connection instance.
getSchedulePreferenceList() - Method in interface ibi.broker.api.cci.ConfigManager
 
getSecondaryRunInterval() - Method in class ibi.broker.api.data.schedule.TimeInfoCustom
 
getSecondaryRunInterval() - Method in class ibi.broker.api.data.schedule.TimeInfoDay
Obtains the secondary run interval, in minutes.
getSecondaryRunInterval() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
getSecondaryRunInterval() - Method in class ibi.broker.api.data.schedule.TimeInfoWeek
Obtains the secondary run interval, in minutes.
getSecondPostProcessingProcedure() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the name of the second of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task.
getSecondPreProcessingProcedure() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the name of the second of two possible pre-processing procedures that can be associated with this WebFOCUS Server Procedure task.
getSecurityManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains the Security Manager that is being used in conjunction with this connection instance.
getSecurityToken() - Method in class ibi.broker.api.cci.CasterConnection
 
getSecurityToken() - Method in class ibi.broker.api.cci.SecurityTokenCredential
Return This security token string of the specified cookie type.
getSecurityToken() - Method in class ibi.broker.api.data.Authenticate
Returns the security token associated with this authenticate object.
getSendFormat() - Method in class ibi.broker.api.data.schedule.TaskFtp
 
getSendFormat() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the String constant representing the format of the report that will be generated by the WebFOCUS Reporting Server.
getSendMode() - Method in class ibi.broker.api.cci.CasterConnectionFactory
 
getServerListByExecId(String, String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getServerName() - Method in class ibi.broker.api.data.schedule.DynamicAddress
Returns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
getServerName() - Method in class ibi.broker.api.data.schedule.TaskFtp
Returns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
getServerName() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the name of the WebFOCUS Reporting Server housing the FOCUS procedure associated with this task.
getServerName() - Method in class ibi.broker.api.data.user.ExecId
 
getServerStatus() - Method in class ibi.broker.api.CasterManagedConnectionFactory
 
getSingleAddress() - Method in class ibi.broker.api.data.schedule.Destination
Obtains the single email address associated with this Destination object.
getSize() - Method in class ibi.broker.api.data.library.Version
Obtains the size of this version of Report Library content.
getSpecVersion() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Returns a string representation of the version of the connector architecture specification that is supported by the resource adapter.
getSshPrivateFormattedKey(String, String, String) - Method in class ibi.broker.scheduler.plugin.DefaultSFTPSecurityExit
 
getSshPrivateFormattedKey(String, String, String) - Method in interface ibi.broker.scheduler.plugin.SFTPSecurityExit
 
getStartTime() - Method in class ibi.broker.api.data.console.Job
Obtains the time that the schedule associated with this job is either put on the queue of the Distribution Server, or sent to the WebFOCUS Reporting Server for execution.
getStartTime() - Method in class ibi.broker.api.data.dslog.DsLog
Obtains the Calendar time when the schedule job run begins.
getStartTime() - Method in class ibi.broker.api.data.schedule.TimeInfo
Obtains a Java Calendar Object indicating the start time for a scheduled event.
getStatus() - Method in class ibi.broker.api.data.console.Job
 
getStatus() - Method in class ibi.broker.api.data.console.JobStatus
 
getStatusLastExecuted() - Method in class ibi.broker.api.data.schedule.Schedule
 
getStorageLibraryEmail() - Method in class ibi.broker.api.data.schedule.StorageLibrary
 
getSubject() - Method in class ibi.broker.api.data.schedule.Notification
Obtains the e-mail address linked to the Subject header to which notification will be sent upon running a schedule in ReportCaster.
getTaskDescription() - Method in class ibi.broker.api.data.dslog.DsLogElement
Obtains the String description of the task associated with the DsLogElement.
getTaskId() - Method in class ibi.broker.api.data.library.Content
 
getTaskList() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains an array of Task objects, with each Task object containing one report to be distributed as part of this schedule.
getTaskRetry() - Method in class ibi.broker.api.data.schedule.Task
 
getTimeInfo() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the TimeInfo object associated with this schedule, which contains the frequency and time parameters indicating when and how often this schedule should run.
getTraceType() - Method in class ibi.broker.api.data.console.JobOptions
 
getTraceType() - Method in class ibi.broker.api.data.schedule.Schedule
Returns the trace type setting, as an integer.
getType() - Method in class ibi.broker.api.data.schedule.Destination
Obtains a String constant representing one of four destination types associated with this Destination object.
getType() - Method in class ibi.broker.api.data.schedule.Notification
Obtains the type of notification message to be sent upon the running of a ReportCaster schedule.
getType() - Method in class ibi.broker.api.data.user.ExecId
 
getType() - Method in class ibi.broker.api.data.ValidationErrorItem
 
getUntilTime() - Method in class ibi.broker.api.data.schedule.TimeInterval
Obtains the time until which a scheduled even will run, as a String, in the format HHmm, where HH is the hour and mm is the minute.
getUrlString() - Method in class ibi.broker.api.data.schedule.TaskUrl
Obtains the URL String associated with this instance of TaskURL.
getUser() - Method in class ibi.broker.api.cci.CasterConnection
Obtain the username of the current ReportCaster user who is accessing this CasterConnection instance.
getUser() - Method in class ibi.broker.api.data.Authenticate
Returns the user name associated with this authenticate object.
getUserByName(String) - Method in interface ibi.broker.api.cci.UserManager
Retrieves a User object based upon the specified ReportCaster username.
getUserByName(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getUserByName(Authenticate, String) - Method in interface ibi.broker.api.ws.UserManagerIF
 
getUserByName(Authenticate, String) - Method in class ibi.broker.api.ws.UserManagerWS
 
getUserId() - Method in class ibi.broker.api.data.library.WatchItem
 
getUserList() - Method in interface ibi.broker.api.cci.UserManager
Retrieves an array of User objects.
getUserList(String) - Method in interface ibi.broker.api.cci.UserManager
 
getUserList() - Method in class ibi.broker.api.data.user.Group
 
getUserList() - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getUserList(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getUserList(Authenticate) - Method in interface ibi.broker.api.ws.UserManagerIF
 
getUserList(Authenticate) - Method in class ibi.broker.api.ws.UserManagerWS
 
getUserListForGroupAdmin() - Method in class ibi.broker.api.data.user.User
 
getUserManager() - Method in class ibi.broker.api.cci.CasterConnection
Obtains an instance of ibi.broker.api.cci.UserManager that is to be used in conjunction with this connection instance.
getUserName() - Method in class ibi.broker.api.cci.CasterConnectionMetaData
Returns the user name for an active connection as known to the underlying EIS instance.
getUserName() - Method in interface ibi.broker.api.cci.Credential
Return the Credential user name.
getUserName() - Method in class ibi.broker.api.cci.PasswordCredential
Retrieves this user's name.
getUserName() - Method in class ibi.broker.api.cci.SecurityTokenCredential
Return This security token's user name.
getUserName() - Method in class ibi.broker.api.cci.WebAuthenticateCredential
Returns the user name contained in the Web server.
getUserName() - Method in class ibi.broker.api.data.schedule.DynamicAddress
Returns the logon name to the Reporting Server which the FOCUS Executable that creates the dynamic distribution list.
getUserName() - Method in class ibi.broker.api.data.schedule.TaskFtp
Retrieves this user's name.
getUserName() - Method in class ibi.broker.api.data.schedule.TaskUrl
Obtains the value of the user name necessary for access to the URL's Web server.
getUserNameListByGroup(String) - Method in interface ibi.broker.api.cci.UserManager
Obtains a string array of usernames that belong to a specified Group as identified by its groupName.
getUserNameListByGroup(String, String) - Method in interface ibi.broker.api.cci.UserManager
 
getUserNameListByGroup(String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getUserNameListByGroup(String, String) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
getUserNameListByGroup(Authenticate, String) - Method in interface ibi.broker.api.ws.UserManagerIF
 
getUserNameListByGroup(Authenticate, String) - Method in class ibi.broker.api.ws.UserManagerWS
 
getValue() - Method in class ibi.broker.api.data.schedule.Parameter
Obtains the value of a parameter associated with a task scheduled for distribution within ReportCaster.
getValue() - Method in class ibi.broker.api.data.ValidationErrorItem
 
getValueArg() - Method in class ibi.broker.api.data.ValidationErrorItem
 
getVersion(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Retrieves the Version object as identified by the versionId key field.
getVersion(String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getVersion(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getVersion(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getVersionList() - Method in class ibi.broker.api.data.library.Content
/** Obtains an Array of Version objects that contains the report output from the ReportCaster schedule that is associated with this Content object.
getVersionNumber() - Method in class ibi.broker.api.data.library.Version
Specifies an integer version number to content in ReportCaster's Report Library database.
getWatchContentInfoList(String) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getWatchContentInfoList(Authenticate, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getWatchContentInfoList(Authenticate, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getWatchItemList() - Method in class ibi.broker.api.data.library.Content
 
getWatchList(String, String) - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getWatchList(String, String, String) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
getWatchList(Authenticate, String, String) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getWatchList(Authenticate, String, String) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getWatchOwnerList() - Method in interface ibi.broker.api.cci.LibraryContentManager
 
getWatchOwnerList(Authenticate) - Method in interface ibi.broker.api.ws.LibraryContentManagerIF
 
getWatchOwnerList(Authenticate) - Method in class ibi.broker.api.ws.LibraryContentManagerWS
 
getWeekOfMonth() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
getZipFileName() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains the name of the zip file associated with a scheduled e-mail distribution.
getZipFileName() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the name of the zip file associated with a scheduled FTP distribution.
GIF - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format GIF.
Group - Class in ibi.broker.api.data.user
The ReportCaster Group class allows the creation and manipulation of ReportCaster authentication and authorization groups.
Group() - Constructor for class ibi.broker.api.data.user.Group
 

H

hashCode() - Method in class ibi.broker.api.data.addrbook.AddrBook
 
hashCode() - Method in class ibi.broker.api.data.addrbook.DestinationElement
 
hashCode() - Method in class ibi.broker.api.data.library.Category
 
HOUR - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of a HOUR.
HOUR - Static variable in class ibi.broker.api.data.schedule.TimeInfo
Interval type indicating execution hourly.
HOUR - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
HTML - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format HTML (Default).
HTML_ODP - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 

I

ibi.broker.api - package ibi.broker.api
 
ibi.broker.api.cci - package ibi.broker.api.cci
 
ibi.broker.api.data - package ibi.broker.api.data
 
ibi.broker.api.data.addrbook - package ibi.broker.api.data.addrbook
 
ibi.broker.api.data.console - package ibi.broker.api.data.console
 
ibi.broker.api.data.dslog - package ibi.broker.api.data.dslog
 
ibi.broker.api.data.library - package ibi.broker.api.data.library
 
ibi.broker.api.data.libraryaccess - package ibi.broker.api.data.libraryaccess
 
ibi.broker.api.data.schedule - package ibi.broker.api.data.schedule
 
ibi.broker.api.data.user - package ibi.broker.api.data.user
 
ibi.broker.api.ws - package ibi.broker.api.ws
 
ibi.broker.scheduler.plugin - package ibi.broker.scheduler.plugin
 
id - Variable in class ibi.broker.api.data.schedule.Distribution
 
id - Variable in class ibi.broker.api.data.schedule.Notification
 
id - Variable in class ibi.broker.api.data.schedule.Task
 
id - Variable in class ibi.broker.api.data.schedule.TimeInfo
 
INACTIVE - Static variable in class ibi.broker.api.data.schedule.Notification
Notification type indicating to never notify upon running Schedule (Default).
invoke(String, String, String, Object[]) - Method in class ibi.broker.api.ws.CasterServiceClient
 
invoke(Service, String, String, String, Object[]) - Method in class ibi.broker.api.ws.CasterServiceClient
 
invoke(String, String, String, Method, Object[], Class[]) - Method in class ibi.broker.api.ws.CasterServiceClient
 
invoke(String, String, String, Method, Object[]) - Method in class ibi.broker.api.ws.CasterServiceClient
 
isActive() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the state of the boolean flag indicating whether or not a scheduled distribution is active.
isActive() - Method in class ibi.broker.api.data.user.User
Returns the user's status as inactive or active.
isAlertEnabled() - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Assigns the value of the boolean flag, which determines whether or not an alert is enabled.
isAsynchronous() - Method in class ibi.broker.api.data.schedule.TaskSchedule
 
isBurst() - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains the value of a boolean flag that specifies whether or not report bursting is enabled.
isCategory() - Method in class ibi.broker.api.data.library.Category
Assigns a Boolean flag indicating whether or not this category has a category name that the user has specified on the user interface when creating a new schedule for generating the reports into the library.
isCompressedReport() - Method in class ibi.broker.api.data.schedule.Schedule
Returns the value of the compressedReport property.
isContentAccessible(String, String) - Method in interface ibi.broker.api.cci.LibraryContentManager
Returns the IDs for which a schedule is accessible.
isDayOfWeekEnabled() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
isDeleteAfterRetrieval() - Method in class ibi.broker.api.data.schedule.TaskFtp
Obtains the state of the boolean flag indicating whether or not a schedule is deleted after retrieval.
isDeleteFileAfterRetrieval() - Method in class ibi.broker.api.data.schedule.TaskFile
 
isDeleteJobAfterRun() - Method in class ibi.broker.api.data.schedule.Schedule
Obtains the state of the boolean flag indicating whether or not a schedule is deleted after running the job.
isEditable() - Method in class ibi.broker.api.data.user.ExecId
 
isEnabled() - Method in class ibi.broker.api.data.schedule.Distribution
 
isEnabled() - Method in class ibi.broker.api.data.schedule.Task
 
isEnabled() - Method in class ibi.broker.api.data.schedule.TimeInterval
 
isError() - Method in class ibi.broker.api.data.dslog.DsLogElement
Obtains a boolean flag specifying whether the message associated with this instance of DsLogELement is an error message.
isExecId(ExecId) - Method in interface ibi.broker.api.cci.UserManager
 
isExecId(ExecId) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
isFriday() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a boolean indicating whether or not the ReportCaster job is scheduled for a Friday.
isLastDayOfMonth() - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Obtains a boolean indicating whether or not the last day of the month flag is set.
isLibraryCapability() - Method in class ibi.broker.api.data.user.User
Returns the user's capability to use the library.
isLogEnabled() - Method in class ibi.broker.api.data.console.JobOptions
 
isMonday() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a boolean indicating whether or not the ReportCaster job is scheduled for a Monday.
isMre() - Method in class ibi.broker.api.data.library.Category
Assigns a Boolean flag indicating whether or not the library report content under this category exists in Managed Reporting.
isMulti() - Method in class ibi.broker.api.data.schedule.AmperParameter
Returns value of isMulti property.
isPassThrow() - Method in class ibi.broker.api.data.user.ExecId
 
isPublicKeyAuthenticationEnabled(String, String, String) - Method in class ibi.broker.scheduler.plugin.DefaultSFTPSecurityExit
 
isPublicKeyAuthenticationEnabled(String, String, String) - Method in interface ibi.broker.scheduler.plugin.SFTPSecurityExit
 
isSameFolder() - Method in class ibi.broker.api.data.schedule.StorageMre
 
isSaturday() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a boolean indicating whether or not the ReportCaster job is scheduled for a Saturday.
isSaveBurstFromList() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Obtains the value of the boolean flag that specifies whether to store only library reports with burst value(s) defined in a specified Access List.
isScheduleCapability() - Method in class ibi.broker.api.data.user.User
Returns the user's capability to Schedule report distributions.
isSendEmailAfterSaveReport() - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
isSendEmailAfterSaveReport() - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Obtains the value of the boolean flag that specifies whether or not an email notification is sent after a report is saved to the library.
isSendingReportAsAttachment() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains the logical value of the flag which specifies whether or not a report scheduled for e-mail distribution is being sent as an attachment.
isShared() - Method in class ibi.broker.api.data.user.ExecId
 
isSMTPAuthenticationEnabled(String) - Method in class ibi.broker.scheduler.plugin.DefaultSMTPSecurityExit
 
isSMTPAuthenticationEnabled(String) - Method in interface ibi.broker.scheduler.plugin.SMTPSecurityExit
 
isSSLEnabled(String) - Method in class ibi.broker.scheduler.plugin.DefaultSMTPSecurityExit
 
isSSLEnabled(String) - Method in interface ibi.broker.scheduler.plugin.SMTPSecurityExit
 
isSTARTTLSEnabled(String) - Method in class ibi.broker.scheduler.plugin.DefaultSMTPSecurityExit
 
isSTARTTLSEnabled(String) - Method in interface ibi.broker.scheduler.plugin.SMTPSecurityExit
 
isStatic() - Method in class ibi.broker.api.data.user.ExecId
 
isStaticDefault() - Method in class ibi.broker.api.data.user.ExecId
 
isSunday() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a boolean indicating whether or not the ReportCaster job is scheduled for a Sunday.
isThursday() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a boolean indicating whether or not the ReportCaster job is scheduled for a Thursday.
isTriggered() - Method in class ibi.broker.api.data.schedule.Alert
Obtains a boolean signifying whether or not the alert has been triggered.
isTrusted() - Method in class ibi.broker.api.data.user.ExecId
 
isTuesday() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a boolean indicating whether or not the ReportCaster job is scheduled for a Tuesday.
isTwoWayEmailAttached() - Method in class ibi.broker.api.data.schedule.Alert
Obtains a boolean signifying whether or not the alert has an attached Two-Way Email message.
isUseUntilTime() - Method in class ibi.broker.api.data.schedule.TimeInterval
 
isWarning() - Method in class ibi.broker.api.data.dslog.DsLogElement
Obtains a boolean flag specifying whether the message associated with this instance of DsLogELement is an warning message.
isWatch() - Method in class ibi.broker.api.data.library.Content
 
isWebAuthenticationEnabled() - Method in class ibi.broker.api.cci.CasterConnectionFactory
 
isWednesday() - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Obtains a boolean indicating whether or not the ReportCaster job is scheduled for a Wednesday.
isZipBurstReportsTogether() - Method in class ibi.broker.api.data.schedule.DistributionFTP
 
isZipEnabled() - Method in class ibi.broker.scheduler.plugin.SCHDomainBasedPassword
 
isZipEnabled() - Method in interface ibi.broker.scheduler.plugin.SCHZipEncryptionPassword
 
isZipResult() - Method in class ibi.broker.api.data.schedule.DistributionEmail
Obtains the logical value of the flag which indicates whether or not to zip the output before sending.
isZipResult() - Method in class ibi.broker.api.data.schedule.DistributionFTP
Obtains the logical value of the flag which indicates whether or not to zip the output before sending.

J

Job - Class in ibi.broker.api.data.console
A Job is an object that represents a schedule when it is set to run on the ReportCaster Distribution Server.
Job() - Constructor for class ibi.broker.api.data.console.Job
 
JOB_END - Static variable in class ibi.broker.scheduler.plugin.JobEvent
 
JOB_START - Static variable in class ibi.broker.scheduler.plugin.JobEvent
 
JobEvent - Class in ibi.broker.scheduler.plugin
 
JobEvent(Job, DsLog, String) - Constructor for class ibi.broker.scheduler.plugin.JobEvent
 
JobListener - Interface in ibi.broker.scheduler.plugin
A listener interface for receiving JobEvents.
JobOptions - Class in ibi.broker.api.data.console
 
JobOptions() - Constructor for class ibi.broker.api.data.console.JobOptions
 
JobStatus - Class in ibi.broker.api.data.console
 
JobStatus() - Constructor for class ibi.broker.api.data.console.JobStatus
 
JOBSTATUS_FINISHED - Static variable in class ibi.broker.api.data.console.JobStatus
 
JOBSTATUS_IN_QUEUE - Static variable in class ibi.broker.api.data.console.JobStatus
 
JOBSTATUS_NO_PERMISSION - Static variable in class ibi.broker.api.data.console.JobStatus
 
JOBSTATUS_NOT_FOUND - Static variable in class ibi.broker.api.data.console.JobStatus
 
JOBSTATUS_RUNNING - Static variable in class ibi.broker.api.data.console.JobStatus
 
JPEG - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 

L

LAST_WEEK_OF_MONTH - Static variable in class ibi.broker.api.data.schedule.TimeInfoMonth
 
LDAP - Static variable in class ibi.broker.api.CasterManagedConnectionFactory
Repository type representing a LDAP directory.
LIBRARY - Static variable in class ibi.broker.api.data.schedule.Distribution
Distribution method indicating the distribution of a scheduled report to the Library.
LIBRARY - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
LibraryAccessBook - Class in ibi.broker.api.data.libraryaccess
The LibraryAccessBook class creates and configures ReportCaster Access Lists.
LibraryAccessBook() - Constructor for class ibi.broker.api.data.libraryaccess.LibraryAccessBook
 
LibraryAccessManager - Interface in ibi.broker.api.cci
 
LibraryAccessManagerClientSF - Class in ibi.broker.api.ws
 
LibraryAccessManagerClientSF(String, String, String) - Constructor for class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
LibraryAccessManagerIF - Interface in ibi.broker.api.ws
 
LibraryAccessManagerWS - Class in ibi.broker.api.ws
 
LibraryAccessManagerWS() - Constructor for class ibi.broker.api.ws.LibraryAccessManagerWS
 
LibraryContentManager - Interface in ibi.broker.api.cci
This interface provides the means of managing the Category, Content, and Version objects that are created as a result of the ReportCaster Distribution Server sending reports to the Report Library.
LibraryContentManagerClientSF - Class in ibi.broker.api.ws
 
LibraryContentManagerClientSF(String, String, String) - Constructor for class ibi.broker.api.ws.LibraryContentManagerClientSF
 
LibraryContentManagerIF - Interface in ibi.broker.api.ws
 
LibraryContentManagerWS - Class in ibi.broker.api.ws
 
LibraryContentManagerWS() - Constructor for class ibi.broker.api.ws.LibraryContentManagerWS
 
LogManager - Interface in ibi.broker.api.cci
This interface provides a way of managing log functionality within ReportCaster.
LogManagerClientSF - Class in ibi.broker.api.ws
 
LogManagerClientSF(String, String, String) - Constructor for class ibi.broker.api.ws.LogManagerClientSF
 
LogManagerIF - Interface in ibi.broker.api.ws
 
LogManagerWS - Class in ibi.broker.api.ws
 
LogManagerWS() - Constructor for class ibi.broker.api.ws.LogManagerWS
 
logon(String, String) - Method in interface ibi.broker.api.ws.LogonManagerIF
LogonManagerIF, accepts a user name and a password.
logon(String, String) - Method in class ibi.broker.api.ws.LogonManagerWS
 
LogonManagerIF - Interface in ibi.broker.api.ws
This interface is used with Web Services.
LogonManagerWS - Class in ibi.broker.api.ws
 
LogonManagerWS() - Constructor for class ibi.broker.api.ws.LogonManagerWS
 

M

MAIL - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
main(String[]) - Static method in class ibi.broker.api.ws.ConsoleManagerClientSF
 
MAINFRAME_JES_RETRIEVE - Static variable in class ibi.broker.api.data.schedule.Task
 
managedConnectionFactory - Variable in class ibi.broker.api.ws.AbstractWebService
 
matchManagedConnections(Set, Subject, ConnectionRequestInfo) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Determines whether there is an existing connection in the connection pool (which contains a pool of ManagedConnection instances and stored in the connection set parameter, set) that can be used as a connection to the ReportCaster Repository.
MHT - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
MINUTE - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of a MINUTE.
MINUTE - Static variable in class ibi.broker.api.data.schedule.TimeInfo
Interval type indicating execution every minute.
MINUTE - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
MONTH - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of a MONTH.
MONTH - Static variable in class ibi.broker.api.data.schedule.TimeInfo
Interval type indicating execution monthly.
MONTH - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
MRE - Static variable in class ibi.broker.api.data.schedule.Distribution
Distribution method indicating the distribution of a scheduled report to Managed Reporting.
MRE - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
MY_REPORT - Static variable in class ibi.broker.api.data.schedule.Task
Task type indicating a Managed Reporting My Report task.
MY_REPORT - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 

N

name - Variable in class ibi.broker.api.data.schedule.TimeInfo
 
nameToString() - Method in class ibi.broker.api.data.schedule.AmperParameter
 
Notification - Class in ibi.broker.api.data.schedule
When scheduled reports are distributed, ReportCaster allows selected individuals to be notified with log information about the distribution.
Notification() - Constructor for class ibi.broker.api.data.schedule.Notification
 

O

ONCE - Static variable in class ibi.broker.api.data.schedule.TimeInfo
Interval type indicating one-time execution.
ONCE - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
ONERROR - Static variable in class ibi.broker.api.data.schedule.Notification
Notification type indicating to notify only if an error is encountered upon running of Schedule.
OptionValue - Class in ibi.broker.api.data.schedule
The OptionValue class is used in conjunction with the AmperParameter class to enable the ReportCaster user to specify the range of valid values for parameters defined within a FOCUS procedure.
OptionValue() - Constructor for class ibi.broker.api.data.schedule.OptionValue
 

P

Parameter - Class in ibi.broker.api.data.schedule
The Parameter class provides a means of obtaining and assigning parameter names and values relating to reporting tasks associated with a ReportCaster scheduled distribution.
Parameter() - Constructor for class ibi.broker.api.data.schedule.Parameter
 
PasswordCredential - Class in ibi.broker.api.cci
THis class is used to pass user name and password information to the CasterConnectionFactory.getConnection() method.
PasswordCredential() - Constructor for class ibi.broker.api.cci.PasswordCredential
Constructor of PasswordCredential.
PasswordCredential(String, char[]) - Constructor for class ibi.broker.api.cci.PasswordCredential
Constructor of PasswordCredential.
PDF - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format PDF.
PNG - Static variable in class ibi.broker.api.data.library.Version
This is one of the valid values of the property format.
PNG - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format PNG.
PPT - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format PPT.
PPT_TEMPLATE - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format PPT TEMPLATE.
PPTX - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format PPTX.
PRINT - Static variable in class ibi.broker.api.data.schedule.Distribution
Distribution method indicating the distribution of a scheduled report to a printer.
PRINT - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
PRIVATE - Static variable in class ibi.broker.api.data.addrbook.AddrBook
PRIVATE is a string constant that indicates the security level of an Address Book.
procedureName - Variable in class ibi.broker.api.data.schedule.Task
 
processJob(JobEvent) - Method in interface ibi.broker.scheduler.plugin.JobListener
Invoked when an job event occurs.
PROPERTY_PASSWORD - Static variable in interface ibi.broker.scheduler.plugin.CacheableDBLocatorExit
 
PROPERTY_URL - Static variable in interface ibi.broker.scheduler.plugin.CacheableDBLocatorExit
 
PROPERTY_USER - Static variable in interface ibi.broker.scheduler.plugin.CacheableDBLocatorExit
 
PS - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format PS.
PUBLIC - Static variable in class ibi.broker.api.data.addrbook.AddrBook
PUBLIC is a string constant that indicates the security level of an Address Book.

R

registerTypeMapping(Service, String, String[]) - Method in class ibi.broker.api.ws.CasterServiceClient
 
reloadDBProperties() - Method in interface ibi.broker.scheduler.plugin.CacheableDBLocatorExit
 
removeJobFromManagerQueue(String) - Method in interface ibi.broker.api.cci.ConsoleManager
 
removeJobFromManagerQueue(Authenticate, String) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
removeJobFromManagerQueue(Authenticate, String) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
removeJobFromQueue(String) - Method in interface ibi.broker.api.cci.ConsoleManager
Provided with a specified job ID, which uniquely identifies a Job, removes the job from ReportCaster's Distribution Server queue.
removeJobFromQueue(Authenticate, String) - Method in interface ibi.broker.api.ws.ConsoleManagerIF
 
removeJobFromQueue(Authenticate, String) - Method in class ibi.broker.api.ws.ConsoleManagerWS
 
removeJobsInQueue(Job[]) - Method in class ibi.broker.api.ws.ConsoleManagerClientSF
 
reportName - Variable in class ibi.broker.api.data.schedule.Task
 
resumeDistributionServer() - Method in interface ibi.broker.api.cci.ConsoleManager
 
returnEcriptedPassword(boolean) - Method in class ibi.broker.api.data.user.ExecId
 
ROLE_CASTER_ADMIN - Static variable in class ibi.broker.api.data.user.User
This is one of the valid values of the property role.
ROLE_USER - Static variable in class ibi.broker.api.data.user.User
This is one of the valid values of the property role.
run(Schedule) - Method in interface ibi.broker.api.cci.ScheduleManager
After a Schedule object has been created and its properties populated with data, this method immediately submits the schedule to the ReportCaster Distribution Server, which runs the schedule.
run(Schedule, JobOptions) - Method in interface ibi.broker.api.cci.ScheduleManager
After a Schedule object has been created and its properties populated with data, this method immediately submits the schedule to the ReportCaster Distribution Server with a JobListener class name, which runs the schedule.
run(String[], JobOptions) - Method in interface ibi.broker.api.cci.ScheduleManager
 
run(Schedule) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
run(String[], JobOptions) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
run(Schedule, JobOptions) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
run(Authenticate, Schedule) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
run(Authenticate, Schedule) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 

S

SCHDomainBasedPassword - Class in ibi.broker.scheduler.plugin
 
SCHDomainBasedPassword() - Constructor for class ibi.broker.scheduler.plugin.SCHDomainBasedPassword
 
Schedule - Class in ibi.broker.api.data.schedule
Encapsulates the process of scheduling reports for distribution by ReportCaster.
Schedule() - Constructor for class ibi.broker.api.data.schedule.Schedule
 
SCHEDULE - Static variable in class ibi.broker.api.data.schedule.Task
 
ScheduleManager - Interface in ibi.broker.api.cci
ScheduleManager This interface provides a means of managing schedules within ReportCaster.
ScheduleManagerClientSF - Class in ibi.broker.api.ws
 
ScheduleManagerClientSF(String, String, String) - Constructor for class ibi.broker.api.ws.ScheduleManagerClientSF
 
ScheduleManagerIF - Interface in ibi.broker.api.ws
 
ScheduleManagerWS - Class in ibi.broker.api.ws
 
ScheduleManagerWS() - Constructor for class ibi.broker.api.ws.ScheduleManagerWS
 
SCHFieldNotFoundException - Exception in ibi.broker.scheduler.plugin
 
SCHFieldNotFoundException(String) - Constructor for exception ibi.broker.scheduler.plugin.SCHFieldNotFoundException
 
SCHZipEncryptionPassword - Interface in ibi.broker.scheduler.plugin
 
SecurityTokenCredential - Class in ibi.broker.api.cci
This class is used to pass the security token (the RC_Cookie or MRE_Cookie) information to the CasterConnectionFactory.getConnection() method.
SecurityTokenCredential() - Constructor for class ibi.broker.api.cci.SecurityTokenCredential
Constructor of SecurityTokenCredential.
SecurityTokenCredential(String) - Constructor for class ibi.broker.api.cci.SecurityTokenCredential
Constructor of SecurityTokenCredential.
selectCustomIntervalList() - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
SERVERTYPE_FTP - Static variable in class ibi.broker.api.data.user.ExecId
 
SERVERTYPE_IWAY - Static variable in class ibi.broker.api.data.user.ExecId
 
SERVERTYPE_WEB - Static variable in class ibi.broker.api.data.user.ExecId
 
setAccess(String) - Method in class ibi.broker.api.data.addrbook.AddrBook
The setAccess method specifies the security level of an Address Book.
setAccessElementList(AccessElement[]) - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Accepts an Array of AccessElements.
setAccessList(String) - Method in class ibi.broker.api.data.library.Content
Assigns the name of the Access List, which is a list of users that have access to this content in the report library.
setAccessList(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Assigns the name of the access list associated with this report distribution to the library.
setAccessType(String) - Method in class ibi.broker.api.data.library.Content
Assigns one of the three access options (i.e., "access types") as a String Constant.
setAccessType(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Assigns the String constant representing the access type for this library distribution.
setAction(String) - Method in class ibi.broker.scheduler.plugin.JobEvent
 
setActive(boolean) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns the boolean flag indicating whether or not a scheduled distribution is active.
setActive(boolean) - Method in class ibi.broker.api.data.user.User
Sets the user's status as inactive or active.
setAddress(String) - Method in class ibi.broker.api.data.user.User
Sets the user's e-mail address.
setAddressForBriefNotification(String) - Method in class ibi.broker.api.data.schedule.Notification
Specifies the e-mail address where a brief notification message will be sent after running a schedule in ReportCaster.
setAddressForFullNotification(String) - Method in class ibi.broker.api.data.schedule.Notification
Specifies the e-mail address where a full notification message will be sent upon running a schedule in ReportCaster.
setAlert(Alert) - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Assigns an Alert object to this task.
setAlertEnabled(boolean) - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Obtains the value of the boolean flag, which determines whether or not an alert is enabled.
setAllowFormatList(String[]) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
setAmperParameter(AmperParameter) - Method in class ibi.broker.api.data.schedule.Parameter
 
setApplicationPreference(ApplicationPreference) - Method in class ibi.broker.api.cci.CasterConnection
 
setArgumentList(Object[]) - Method in exception ibi.broker.api.data.CasterException
 
setAsynchronous(boolean) - Method in class ibi.broker.api.data.schedule.TaskSchedule
 
setAuthenticationExit(String) - Method in class ibi.broker.api.cci.CasterConnectionFactory
Specifies the AuthenticationExit's class or interface name.
setBookName(String) - Method in class ibi.broker.api.data.addrbook.AddrBook
Specifies the name of an Address Book.
setBurst(boolean) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the value of a boolean flag that specifies whether or not report bursting is enabled.
setBurstValue(String) - Method in class ibi.broker.api.data.addrbook.DestinationElement
Accepts the burst value associated with this DestinationElement.
setBurstValue(String) - Method in class ibi.broker.api.data.library.Content
Assigns the burst value associated with this library report distribution.
setBurstValue(String) - Method in class ibi.broker.api.data.libraryaccess.AccessElement
Specifies the burst value for a scheduled job.
setCategory(boolean) - Method in class ibi.broker.api.data.library.Category
Obtains a Boolean flag indicating whether or not this category has a category name that the user has specified on the user interface when creating a new schedule for generating the reports into the library.
setCategory(Category) - Method in class ibi.broker.api.data.library.Content
 
setCategory(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Assigns the library category associated with this report.
setCompressedReport(boolean) - Method in class ibi.broker.api.data.schedule.Schedule
Sets the value of the compressedReport property.
setCompressFormat(String) - Method in class ibi.broker.api.data.library.Version
 
setCompressSize(long) - Method in class ibi.broker.api.data.library.Version
 
setConfig(CasterConfig) - Method in class ibi.broker.api.cci.CasterConnectionFactory
Assigns the Configuration file for the Distribution server.
setConfigPath(String) - Method in class ibi.broker.api.CasterManagedConnectionFactoryMigration
 
setContentId(String) - Method in class ibi.broker.api.data.library.WatchItem
 
setContentList(Content[]) - Method in class ibi.broker.api.data.library.Category
Assigns an Array of report library Content objects that are nested into this category.As the category is the parent of content in the hierarchical scheme, the content list provides access to the actual content for a given instance of category.
setCreateDate(Calendar) - Method in class ibi.broker.api.data.library.Version
Assigns the creation date for this version of Report Library content.
setDateList(Calendar[]) - Method in class ibi.broker.api.data.schedule.TimeInfoCustom
 
setDayOfWeek(int) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
setDayOfWeekEnabled(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
setDaysOfMonth(boolean[]) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Assigns a 31 element array of booleans indicating which days of the month have been selected for a report to run.
setDefaultValue(String) - Method in class ibi.broker.api.data.schedule.AmperParameter
getDefaultValue() assigns the default value that has been assigned to the parameter defined within the FOCUS procedure.
setDeleteAfterRetrieval(boolean) - Method in class ibi.broker.api.data.schedule.TaskFtp
Assigns a boolean flag indicating whether or not a schedule is deleted after retrieval.
setDeleteFileAfterRetrieval(boolean) - Method in class ibi.broker.api.data.schedule.TaskFile
 
setDeleteJobAfterRun(boolean) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns a boolean flag indicating whether or not a schedule is deleted after running the job.
setDescription(String) - Method in class ibi.broker.api.data.library.Content
Assigns a string describing this scheduled distribution of report library content.
setDescription(String) - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Specifies the description of an Access List.
setDescription(String) - Method in class ibi.broker.api.data.schedule.Distribution
 
setDescription(String) - Method in class ibi.broker.api.data.schedule.Notification
 
setDescription(String) - Method in class ibi.broker.api.data.schedule.OptionValue
Specifies the text used to describe what the option value is.
setDescription(String) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns the text describing the job that is being scheduled.
setDescription(String) - Method in class ibi.broker.api.data.schedule.Task
Assigns the text used to describe the task.
setDescription(String) - Method in class ibi.broker.api.data.schedule.TimeInfo
 
setDescription(String) - Method in class ibi.broker.api.data.user.Group
Sets the description of the ReportCaster Group.
setDescription(String) - Method in class ibi.broker.api.data.user.User
Sets the description of the user.
setDestination(Destination) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Assigns the destination by accepting a Destination object that can be one of the four types: Distribution List, Distribution File, Single Address, and Dynamic Address.
setDestination(Destination) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Assigns the destination object, which contains information indicating where the scheduled report will be distributed.
setDestination(Destination) - Method in class ibi.broker.api.data.schedule.DistributionPrint
Assigns the destination object, which contains information indicating the target(s) of distribution.
setDestinationList(DestinationElement[]) - Method in class ibi.broker.api.data.addrbook.AddrBook
Accepts an Array of DestinationElements.
setDistribution(Distribution) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns the Distribution object associated with this Schedule.
setDistributionFile(String) - Method in class ibi.broker.api.data.schedule.Destination
This method assigns a distribution file, in the form of a fully qualified path to a file accessible from the distribution server, to this Destination object.
setDistributionList(String) - Method in class ibi.broker.api.data.schedule.Destination
Sets the distribution list name to this Destination object.
setDistributionServerName(String) - Method in class ibi.broker.api.data.console.Job
 
setDomainHREF(String) - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Assigns the value of the domain that is a part of the URI that references the Standard Report on the Managed Report Server.
setDsLog(DsLog) - Method in class ibi.broker.api.data.console.JobStatus
 
setDsLog(DsLog) - Method in class ibi.broker.scheduler.plugin.JobEvent
 
setDSTTraceWorker(DSTTraceWorker) - Method in class ibi.broker.api.cci.CasterConnectionFactory
 
setDuration(int) - Method in class ibi.broker.api.data.schedule.TimeInterval
Assigns the duration of a scheduled event, in minutes.
setDynamicAddress(DynamicAddress) - Method in class ibi.broker.api.data.schedule.Destination
Assigns the DynamicAddress object associated with this Destination object.
setEditable(boolean) - Method in class ibi.broker.api.data.user.ExecId
 
setEnabled(boolean) - Method in class ibi.broker.api.data.schedule.Distribution
 
setEnabled(boolean) - Method in class ibi.broker.api.data.schedule.Task
 
setEnabled(boolean) - Method in class ibi.broker.api.data.schedule.TimeInterval
 
setEndTime(Calendar) - Method in class ibi.broker.api.data.dslog.DsLog
Assigns the Calendar time when the schedule job run ends.
setEndTime(Calendar) - Method in class ibi.broker.api.data.schedule.TimeInfoCustom
 
setEndTime(Calendar) - Method in class ibi.broker.api.data.schedule.TimeInfoDay
Assigns a Java Calendar Object indicating the end time for a scheduled event.
setEndTime(Calendar) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a Java Calendar Object indicating the end time for a ReportCaster schedule.
setEndTime(Calendar) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Assigns a Java Calendar Object indicating the end time for the schedule associated with this TimeInfoMonth instance.
setError(boolean) - Method in class ibi.broker.api.data.dslog.DsLogElement
Assigns a boolean flag specifying whether or not the message associated with this instance of DsLogELement is an error message.
setErrorType(String) - Method in class ibi.broker.api.data.dslog.DsLog
Assigns a String constant specifies the type of error that may have occurred during the scheduled report distribution job run.
setExecId(String) - Method in class ibi.broker.api.data.dslog.DsLogElement
Assigns the execution ID to this instance of DslogElement.
setExecId(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the user name needed to establish a connection to the WebFOCUS Reporting Server.
setExecPassword(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the password needed to establish a connection to the WebFOCUS Reporting Server.
setExpirationData(int) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Assigns the expiration data used to calculate the expiration of a Library resident report.
setExpirationMode(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Assigns the expiration mode as a String constant.
setExpireDate(Calendar) - Method in class ibi.broker.api.data.library.Version
Assigns the expiration date for this version of Report Library content.
setExpireInterval(int) - Method in class ibi.broker.api.data.library.Content
Assigns the expiration interval to a report content distributed to the report library.
setExpireMode(String) - Method in class ibi.broker.api.data.library.Content
Assigns the expiration mode for the report library content.
setFileName(String) - Method in class ibi.broker.api.data.schedule.TaskFile
Assigns the name of the file to be scheduled for distribution by ReportCaster.
setFileName(String) - Method in class ibi.broker.api.data.schedule.TaskFtp
Assigns the name of the file to be scheduled for distribution by ReportCaster.
setFirstPostProcessingProcedure(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the name of the first of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task.
setFirstPreProcessingProcedure(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the name of the first of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task.
setFirstTask(Task) - Method in class ibi.broker.api.data.schedule.Schedule
 
setFolderHREF(String) - Method in class ibi.broker.api.data.schedule.TaskStandardReport
Assigns the value of the folder that is a part of the URI that references the Standard Report on the Managed Report Server.
setFolderName(String) - Method in class ibi.broker.api.data.schedule.StorageMre
Assigns the name of the folder to which you are sending a report for scheduled distribution to Managed Reporting.
setFormat(String) - Method in class ibi.broker.api.data.library.Version
Assigns the format of this version of Report Library content as a String constant.
setFormat(String) - Method in class ibi.broker.api.data.schedule.AmperParameter
 
setFrequency(int) - Method in class ibi.broker.api.data.schedule.TimeInfoDay
Assigns the frequency for a scheduled event, in days.
setFrequency(int) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns the frequency for a scheduled event, in minutes.
setFrequency(int) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Assigns the frequency for a scheduled distribution.
setFriday(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a boolean indicating whether or not the ReportCaster job is scheduled for a Friday.
setFrom(String) - Method in class ibi.broker.api.data.schedule.Notification
Specifies the e-mail address linked to the "From" header to which notification will be sent upon running a schedule in ReportCaster.
setFtpLocation(String) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Assigns the virtual directory for a report scheduled for distribution via FTP.
setFtpPassword(String) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Assigns the password to the target FTP server needed to authenticate at the time of report distribution.
setFtpServerName(String) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Assigns the name of the FTP server that is the target of the distribution.
setFtpUserName(String) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Assigns the username needed to authenticate to the target FTP server at the time of report distribution.
setFullyQualifiedServerName(String) - Method in class ibi.broker.api.data.console.Job
 
setIbiDocumentRoot(String) - Method in class ibi.broker.api.CasterManagedConnectionFactory
 
setId(String) - Method in class ibi.broker.api.data.console.Job
Specifies a String identifier associated with this Job on the ReportCaster Console.
setId(String) - Method in class ibi.broker.api.data.library.WatchItem
 
setId(String) - Method in class ibi.broker.api.data.schedule.Distribution
 
setId(String) - Method in class ibi.broker.api.data.schedule.Notification
 
setId(String) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns a unique identifier to this schedule.
setId(String) - Method in class ibi.broker.api.data.schedule.Task
Assigns the unique identifier ReportCaster generates for every saved task.
setId(String) - Method in class ibi.broker.api.data.schedule.TimeInfo
 
setId(String) - Method in class ibi.broker.api.data.user.Group
 
setIndexFile(String) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Specifies the index file associated with report(s) scheduled for distribution via FTP where bursting is activated.
setInlineMessage(String) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Sets the inline message associated with an e-mail report distribution.
setInlineTaskIndex(int) - Method in class ibi.broker.api.data.schedule.DistributionEmail
This method sets the index of the task that is going to be inline (in the body of the email).
setInterval(int) - Method in class ibi.broker.api.data.schedule.TimeInterval
Assigns the interval for a scheduled event, in minutes.
setJob(Job) - Method in class ibi.broker.scheduler.plugin.JobEvent
 
setJobId(String) - Method in class ibi.broker.api.data.dslog.DsLog
The Distribution Server uses this method to assign a unique identifier to the log or record of a ReportCaster job.
setJobListenerClassName(String) - Method in class ibi.broker.api.data.console.JobOptions
 
setLastDayOfMonth(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
Assigns a boolean indicating whether or not the last day of the month flag is set.
setLastExecTime(Calendar) - Method in class ibi.broker.api.data.library.Content
 
setLastTimeExecuted(Calendar) - Method in class ibi.broker.api.data.schedule.Schedule
 
setLastVersion(int) - Method in class ibi.broker.api.data.library.Content
 
setLibraryCapability(boolean) - Method in class ibi.broker.api.data.user.User
Sets the user's capability to use the library.
setLibraryURL(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
setLibraryURL(String) - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Assigns the base URL contained in a library email notification.
setLocation(String) - Method in class ibi.broker.api.data.addrbook.DestinationElement
A ccepts a destination location representing a single destination in an address book.
setLogElementList(DsLogElement[]) - Method in class ibi.broker.api.data.dslog.DsLog
Assigns the Array of(DsLogElement[]) objects that are associated with this instance of the DsLog class.
setLogEnabled(boolean) - Method in class ibi.broker.api.data.console.JobOptions
 
setLogWriter(PrintWriter) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Sets the log writer for this CasterManagedConnectionFactory instance.
setLogWriter(PrintWriter) - Method in class ibi.broker.api.cci.CasterConnection
 
setMailFrom(String) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Specifies the e-mail address associated with the From header field of a scheduled e-mail distribution.
setMailFrom(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
setMailFrom(String) - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Assigns the "From" email address in this Library email notification (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()).
setMailMessage(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
setMailMessage(String) - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Assigns the email message content contained in the email message sent out as part of this notification email (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()).
setMailReplyAddress(String) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Specifies the reply e-mail address from Reply Address header field of a scheduled e-mail distribution.
setMailReplyAddress(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
setMailReplyAddress(String) - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Assigns the "Reply" email address sent in this Library email notification.
setMailServerName(String) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Assigns a SMTP mail server name associated with scheduled e-mail distribution.
setMailServerName(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
setMailServerName(String) - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Assigns the mail server name used to send this library email notification.
setMailSubject(String) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Assigns an e-mail Subject corresponding to the Subject header field associated with scheduled e-mail distribution.
setMailSubject(String) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
setMailSubject(String) - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Assigns the email subject sent in this library email notification.
setMaximum(String) - Method in class ibi.broker.api.data.schedule.AmperParameter
 
setMemberName(String) - Method in class ibi.broker.api.data.libraryaccess.AccessElement
Specifies the members (clientIds) associated with a Library Access List.This value may be an individual ReportCaster user, or a group.
setMemberType(String) - Method in class ibi.broker.api.data.libraryaccess.AccessElement
Specifies the type for a member.
setMessage(String) - Method in class ibi.broker.api.data.dslog.DsLogElement
Assigns the log text describing exactly what takes place in the job execution process during this instance of DsSLogElement.
setMessageCode(String) - Method in class ibi.broker.api.data.dslog.DsLogElement
Assigns the message code corresponding as a String constant to this instance of DsLogElement.
setMethod(String) - Method in class ibi.broker.api.data.addrbook.AddrBook
Specifies the distribution method for an Address Book.
setMinimum(String) - Method in class ibi.broker.api.data.schedule.AmperParameter
 
setMonday(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a boolean indicating whether or not the ReportCaster job is scheduled for a Monday.
setMre(boolean) - Method in class ibi.broker.api.data.library.Category
Obtains a Boolean flag indicating whether or not the library report content under this category exists in Managed Reporting.
setMrRole(String) - Method in class ibi.broker.api.cci.CasterConnection
 
setMrRole(String) - Method in class ibi.broker.api.data.user.User
 
setMulti(boolean) - Method in class ibi.broker.api.data.schedule.AmperParameter
Sets value of isMulti property.
setName(String) - Method in class ibi.broker.api.data.library.Category
Assigns the name of the category under which report library content and their related version objects will be organized.
setName(String) - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Specifies the unique name of an Access List.
setName(String) - Method in class ibi.broker.api.data.schedule.OptionValue
Obtains the name given to a particular option value.
setName(String) - Method in class ibi.broker.api.data.schedule.Parameter
Specifies the name of a parameter associated with a task scheduled for distribution within ReportCaster.
setName(String) - Method in class ibi.broker.api.data.schedule.TimeInfo
 
setName(String) - Method in class ibi.broker.api.data.user.ExecId
 
setName(String) - Method in class ibi.broker.api.data.user.Group
Sets the name of the Group.
setName(String) - Method in class ibi.broker.api.data.user.User
Sets the user's login name, also known as the casterUser or ReportCaster ID.
setName(String) - Method in class ibi.broker.api.data.ValidationErrorItem
 
setNextRunTime(Calendar) - Method in class ibi.broker.api.data.schedule.TimeInfo
Assigns a Java Calendar Object indicating the next run time for a scheduled event.
setNotification(Notification) - Method in class ibi.broker.api.data.schedule.Schedule
Specifies the Notification object associated with this Schedule.
setOperation(String) - Method in class ibi.broker.api.data.schedule.AmperParameter
 
setOptionValueList(OptionValue[]) - Method in class ibi.broker.api.data.schedule.AmperParameter
Populates an array representing the range of valid options for a given parameter as defined within a FOCUS procedure.
setOwner(String) - Method in class ibi.broker.api.data.addrbook.AddrBook
Indicates the owner of an Address Book.
setOwner(String) - Method in class ibi.broker.api.data.dslog.DsLog
Assigns the username of the schedule owner.
setOwner(String) - Method in class ibi.broker.api.data.library.Content
Assigns an owner to this scheduled distribution of content to the Report Library.
setOwner(String) - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Specifies the ID of the owner of an Access List.
setOwner(String) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns the owner of this schedule.
setOwner(String) - Method in class ibi.broker.api.data.user.ExecId
 
setParameterDescription(String) - Method in class ibi.broker.api.data.schedule.AmperParameter
 
setParameterList(Parameter[]) - Method in class ibi.broker.api.data.schedule.TaskUrl
Assigns an array of Parameters objects to be associated with an instance of TaskURL.
setParameterList(Parameter[]) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Obtains an array of Parameter objects, with each object representing a name value pair, that is matched and then resolved upon the execution of this WebFOCUS Server procedure.
setParameterName(String) - Method in class ibi.broker.api.data.schedule.AmperParameter
Assigns a name of the parameter associated with an instance of AmperParameter.
setPassThrow(boolean) - Method in class ibi.broker.api.data.user.ExecId
 
setPassword(char[]) - Method in class ibi.broker.api.cci.PasswordCredential
Sets this password, as a character Array, to this PasswordCredential.
setPassword(String) - Method in class ibi.broker.api.data.Authenticate
Accepts the password necessary to authenticate.
setPassword(String) - Method in class ibi.broker.api.data.schedule.DynamicAddress
Sets the value of the password required for authentication to the reporting server containing the FOCUS Procedure that creates the dynamic distribution list.
setPassword(String) - Method in class ibi.broker.api.data.schedule.TaskFtp
Sets this password, as a character Array, to this PasswordCredential.
setPassword(String) - Method in class ibi.broker.api.data.schedule.TaskUrl
Assigns the value of the password necessary for access to the URL's Web server.
setPassword(String) - Method in class ibi.broker.api.data.user.ExecId
 
setPassword(String) - Method in class ibi.broker.api.data.user.User
Sets the password associated with user name.
setPath(String) - Method in class ibi.broker.scheduler.plugin.SCHDomainBasedPassword
 
setPortNumber(String) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Specifies the ReportCaster Distribution Server's port number.
setPriority(int) - Method in class ibi.broker.api.data.console.JobOptions
 
setPriority(int) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns the priority level for the scheduled job.
setProcedureDescription(String) - Method in class ibi.broker.api.data.schedule.TaskStandardReport
 
setProcedureName(String) - Method in class ibi.broker.api.data.schedule.DynamicAddress
Assigns the name of the FOCUS Executable that produces the dynamic distribution list.
setProcedureName(String) - Method in class ibi.broker.api.data.schedule.Task
Assigns the name of the FOCUS executable procedure ("FOCEXEC") that resides on the reporting server that is associated with this task.
setProcedureName(String) - Method in class ibi.broker.api.data.schedule.TaskFile
 
setProcedureName(String) - Method in class ibi.broker.api.data.schedule.TaskFtp
 
setReference(Reference) - Method in class ibi.broker.api.cci.CasterConnectionFactory
Sets the Reference instance.
setReporsitoryType(int) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Specifies the repository type.
setReportName(String) - Method in class ibi.broker.api.data.schedule.Task
Assigns the name of the report associated with this task.
setRepositoryType(int) - Method in class ibi.broker.api.cci.CasterConnectionFactory
Sets the ReportCaster repository type specified as an integer value.
setRequest(HttpServletRequest) - Method in class ibi.broker.api.cci.WebAuthenticateCredential
Sets the HTTP Servlet request object.
setResetInterval(int) - Method in class ibi.broker.api.data.schedule.Alert
Assigns the time interval (delay) between when an alert schedule is run upon being triggered and when it is reactivated.
setResetType(String) - Method in class ibi.broker.api.data.schedule.Alert
Assigns the reset type for an alert in the form of a String Constant.
setRole(String) - Method in class ibi.broker.api.data.user.User
Accepts a String constant representing the user's ReportCaster role.
setSameFolder(boolean) - Method in class ibi.broker.api.data.schedule.StorageMre
 
setSaturday(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a boolean indicating whether or not the ReportCaster job is scheduled for a Saturday.
setSaveBurstFromList(boolean) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Asigns the value of the boolean flag that specifies whether to store only library reports with burst value(s) defined in a specified Access List.
setSchedule(Schedule) - Method in class ibi.broker.api.data.console.Job
Assigns the Schedule object to be run on the Distribution Server.
setSchedule(Schedule) - Method in class ibi.broker.scheduler.plugin.SCHDomainBasedPassword
 
setSchedule(Schedule) - Method in interface ibi.broker.scheduler.plugin.SCHZipEncryptionPassword
 
setScheduleCapability(boolean) - Method in class ibi.broker.api.data.user.User
Sets the user's capability to Schedule report distributions.
setScheduleDescription(String) - Method in class ibi.broker.api.data.dslog.DsLog
Assigns the text describing the Schedule that is being run and logged on the Distribution Server.
setScheduleId(String) - Method in class ibi.broker.api.data.dslog.DsLog
Assigns the unique identifier to the schedule that is being run and logged on the Distribution Server.
setScheduleId(String) - Method in class ibi.broker.api.data.library.Content
 
setScheduleId(String) - Method in class ibi.broker.api.data.schedule.TaskSchedule
 
setSecondaryRunInterval(TimeInterval) - Method in class ibi.broker.api.data.schedule.TimeInfoCustom
 
setSecondaryRunInterval(TimeInterval) - Method in class ibi.broker.api.data.schedule.TimeInfoDay
Assigns the secondary run interval, in minutes.
setSecondaryRunInterval(TimeInterval) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
setSecondaryRunInterval(TimeInterval) - Method in class ibi.broker.api.data.schedule.TimeInfoWeek
Assigns the secondary run interval, in minutes.
setSecondPostProcessingProcedure(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the name of the second of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task.
setSecondPreProcessingProcedure(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the name of the second of two possible pre-processing procedures that can be associated with this WebFOCUS Server Procedure task.
setSecurityManager(CasterSecurityManager) - Method in class ibi.broker.api.cci.CasterConnection
Specifies the Security Manager for use with this CasterConnection instance.
setSecurityToken(String) - Method in class ibi.broker.api.cci.SecurityTokenCredential
Set a security token string in the format accepted by the token type.
setSecurityToken(String) - Method in class ibi.broker.api.data.Authenticate
Sets the security token associated with this authenticate object.
setSendEmailAfterSaveReport(boolean) - Method in class ibi.broker.api.data.schedule.StorageLibrary
Deprecated.  
setSendEmailAfterSaveReport(boolean) - Method in class ibi.broker.api.data.schedule.StorageLibraryEmail
Assigns the value of the boolean flag that specifies whether or not an email notification is sent after a report is saved to the library.
setSendFormat(String) - Method in class ibi.broker.api.data.schedule.TaskFtp
 
setSendFormat(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the String constant representing the format of the report that will be generated by the WebFOCUS Reporting Server.
setSendingReportAsAttachment(boolean) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Assigns the logical value of the flag which specifies whether or not a report scheduled for e-mail distribution is being sent as an attachment.
setSendMode(Hashtable) - Method in class ibi.broker.api.cci.CasterConnectionFactory
 
setServerName(String) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Specifies the server name where ReportCaster Distribution Server is located.
setServerName(String) - Method in class ibi.broker.api.data.schedule.DynamicAddress
Assigns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
setServerName(String) - Method in class ibi.broker.api.data.schedule.TaskFtp
Assigns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
setServerName(String) - Method in class ibi.broker.api.data.schedule.TaskWFServerProcedure
Assigns the name of the WebFOCUS Reporting Server housing the FOCUS procedure associated with this task.
setServerName(String) - Method in class ibi.broker.api.data.user.ExecId
 
setShared(boolean) - Method in class ibi.broker.api.data.user.ExecId
 
setSingleAddress(String) - Method in class ibi.broker.api.data.schedule.Destination
Assigns the single email address associated with this Destination object.
setSize(long) - Method in class ibi.broker.api.data.library.Version
Assigns the size of this version of Report Library content.
setStartTime(Calendar) - Method in class ibi.broker.api.data.console.Job
Specifies the time that the schedule associated with this job is either put on the queue of the Distribution Server or sent to the WebFOCUS Reporting Server for execution.
setStartTime(Calendar) - Method in class ibi.broker.api.data.dslog.DsLog
Assigns the Calendar time when the schedule job run begins.
setStartTime(Calendar) - Method in class ibi.broker.api.data.schedule.TimeInfo
Assigns a Java Calendar Object indicating the start time for a scheduled event.
setStatic(boolean) - Method in class ibi.broker.api.data.user.ExecId
 
setStaticDefault(boolean) - Method in class ibi.broker.api.data.user.ExecId
 
setStatus(int) - Method in class ibi.broker.api.data.console.Job
 
setStatus(int) - Method in class ibi.broker.api.data.console.JobStatus
 
setStatusLastExecuted(String) - Method in class ibi.broker.api.data.schedule.Schedule
 
setStorageLibraryEmail(StorageLibraryEmail) - Method in class ibi.broker.api.data.schedule.StorageLibrary
 
setSubject(String) - Method in class ibi.broker.api.data.schedule.Notification
Specifies the e-mail address linked to the Subject header to which notification will be sent upon running a schedule in ReportCaster.
setSunday(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a boolean indicating whether or not the ReportCaster job is scheduled for a Sunday.
setTaskDescription(String) - Method in class ibi.broker.api.data.dslog.DsLogElement
Assigns the String description of the task associated with the DsLogElement.
setTaskId(String) - Method in class ibi.broker.api.data.library.Content
 
setTaskList(Task[]) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns an array of Task objects, with each Task object containing one report that is to be distributed as part of this schedule.
setTaskRetry(TimeInterval) - Method in class ibi.broker.api.data.schedule.Task
 
setThursday(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a boolean indicating whether or not the ReportCaster job is scheduled for a Thursday.
setTimeInfo(TimeInfo) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns the TimeInfo object associated to this schedule, which contains the frequency and time parameters indicating when and how often this schedule should run.
setTraceType(int) - Method in class ibi.broker.api.data.console.JobOptions
 
setTraceType(int) - Method in class ibi.broker.api.data.schedule.Schedule
Assigns the trace type setting, as an integer.
setTriggered(boolean) - Method in class ibi.broker.api.data.schedule.Alert
Assigns a Boolean signifying whether or not the alert has been triggered.
setTrusted(boolean) - Method in class ibi.broker.api.data.user.ExecId
 
setTrustedKeyFile(String) - Method in class ibi.broker.api.CasterManagedConnectionFactory
Deprecated. this method is no longer needed.
setTuesday(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a boolean indicating whether or not the ReportCaster job is scheduled for a Tuesday.
setTwoWayEmailAttached(boolean) - Method in class ibi.broker.api.data.schedule.Alert
Assigns a boolean signifying whether or not the alert has an attached Two-Way Email message.
setType(String) - Method in class ibi.broker.api.data.schedule.Destination
Assigns a String constant representing one the four types of destinations associated with this Destination object.
setType(String) - Method in class ibi.broker.api.data.schedule.Notification
Specifies the type of notification message to be sent upon the running of a ReportCaster schedule.
setType(String) - Method in class ibi.broker.api.data.user.ExecId
 
setType(String) - Method in class ibi.broker.api.data.ValidationErrorItem
 
setUntilTime(Calendar) - Method in class ibi.broker.api.data.schedule.TimeInterval
Assigns the time until which a scheduled even will run, as a String, in the format HHmm, where HH is the hour and mm is the minute.
setUrlString(String) - Method in class ibi.broker.api.data.schedule.TaskUrl
Assigns the URL String associated with this instance of TaskURL.
setUser(String) - Method in class ibi.broker.api.data.Authenticate
Accepts the user name needed to authenticate
setUserId(String) - Method in class ibi.broker.api.data.library.WatchItem
 
setUserList(String[]) - Method in class ibi.broker.api.data.user.Group
 
setUserListForGroupAdmin(String[]) - Method in class ibi.broker.api.data.user.User
 
setUserName(String) - Method in class ibi.broker.api.cci.PasswordCredential
Set user name to PasswordCredential.
setUserName(String) - Method in class ibi.broker.api.data.schedule.DynamicAddress
Assigns the logon name to the Reporting Server which contains the FOCUS Executable that creates the dynamic distribution list.
setUserName(String) - Method in class ibi.broker.api.data.schedule.TaskFtp
Set user name to PasswordCredential.
setUserName(String) - Method in class ibi.broker.api.data.schedule.TaskUrl
Assigns the value of the user name necessary for access to the URL's Web server.
setUseUntilTime(boolean) - Method in class ibi.broker.api.data.schedule.TimeInterval
 
setValue(String) - Method in class ibi.broker.api.data.schedule.Parameter
Specifies the value of a parameter associated with a task scheduled for distribution within ReportCaster.
setValue(String) - Method in class ibi.broker.api.data.ValidationErrorItem
 
setValueArg(String[]) - Method in class ibi.broker.api.data.ValidationErrorItem
 
setVersionList(Version[]) - Method in class ibi.broker.api.data.library.Content
Assigns an Array of Version objects that contains the report output from the ReportCaster schedule that is associated with this Content object.
setVersionNumber(int) - Method in class ibi.broker.api.data.library.Version
Assigns an integer version number to the content in ReportCaster's Report Library database.
setWarning(boolean) - Method in class ibi.broker.api.data.dslog.DsLogElement
Assigns a boolean flag specifying whether or not the message associated with this instance of DsLogELement is an warning message.
setWatch(boolean) - Method in class ibi.broker.api.data.library.Content
 
setWatchItemList(WatchItem[]) - Method in class ibi.broker.api.data.library.Content
 
setWebAuthenticationEnabled(boolean) - Method in class ibi.broker.api.cci.CasterConnectionFactory
Specifies the value of a boolean flag which indicates whether or not WebAuthentication is turned on.
setWednesday(boolean) - Method in class ibi.broker.api.data.schedule.TimeInfoMinute
Assigns a boolean indicating whether or not the ReportCaster job is scheduled for a Wednesday.
setWeekOfMonth(int) - Method in class ibi.broker.api.data.schedule.TimeInfoMonth
 
setZipBurstReportsTogether(boolean) - Method in class ibi.broker.api.data.schedule.DistributionFTP
 
setZipFileName(String) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Assigns the name of the zip file associated with a scheduled e-mail distribution.
setZipFileName(String) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Assigns the name of the zip file associated with a scheduled FTP distribution.
setZipResult(boolean) - Method in class ibi.broker.api.data.schedule.DistributionEmail
Assigns a logical value to a flag that determines whether or not to zip report l output before sending via email.
setZipResult(boolean) - Method in class ibi.broker.api.data.schedule.DistributionFTP
Assigns a logical value to a flag that determines whether or not to zip report l output before sending via email.
SFTP - Static variable in class ibi.broker.api.data.schedule.Distribution
 
SFTPSecurityExit - Interface in ibi.broker.scheduler.plugin
 
SINGLE_ADDRESS - Static variable in class ibi.broker.api.data.schedule.Destination
Destination type indicating single address.
SMTPSecurityExit - Interface in ibi.broker.scheduler.plugin
 
STANDARD_REPORT - Static variable in class ibi.broker.api.data.schedule.Task
Task type indicating a Managed Reporting Standard Report task.
STANDARD_REPORT - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
StorageLibrary - Class in ibi.broker.api.data.schedule
 
StorageLibrary() - Constructor for class ibi.broker.api.data.schedule.StorageLibrary
 
StorageLibraryEmail - Class in ibi.broker.api.data.schedule
 
StorageLibraryEmail() - Constructor for class ibi.broker.api.data.schedule.StorageLibraryEmail
 
StorageMre - Class in ibi.broker.api.data.schedule
Managed Reporting storage is one of five distribution types supported by ReportCaster.
StorageMre() - Constructor for class ibi.broker.api.data.schedule.StorageMre
 
supportsExecuteWithInputAndOutputRecord() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Not currently supported.
supportsExecuteWithInputRecordOnly() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Not currently supported.
supportsLocalTransactionDemarcation() - Method in class ibi.broker.api.cci.CasterResourceAdapterMetaData
Not currently supported.
suspendDistributionServer() - Method in interface ibi.broker.api.cci.ConsoleManager
 
SVG - Static variable in class ibi.broker.api.data.library.Version
This is one of the valid values of the property format.
SVG - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format SVG.

T

TAB - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
TABT - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format TABT.
Task - Class in ibi.broker.api.data.schedule
The Task class is an abstract class used to derive classes representing the six ReportCaster task objects: 1.
Task() - Constructor for class ibi.broker.api.data.schedule.Task
 
Task.SystemTask - Class in ibi.broker.api.data.schedule
 
Task.SystemTask() - Constructor for class ibi.broker.api.data.schedule.Task.SystemTask
 
TaskFile - Class in ibi.broker.api.data.schedule
The TaskFile class is one of six task types supported by ReportCaster (WebFOCUS Server procedure, MyReport, Standard Report, FTP, and URL are the others).
TaskFile() - Constructor for class ibi.broker.api.data.schedule.TaskFile
 
TaskFtp - Class in ibi.broker.api.data.schedule
The TaskFTP class is one of six task types supported by ReportCaster (WebFOCUS Server procedure, MyReport, Standard Report, File, and URL are the others).
TaskFtp() - Constructor for class ibi.broker.api.data.schedule.TaskFtp
 
TaskMyReport - Class in ibi.broker.api.data.schedule
The TaskMyReport class is one of six task types supported by ReportCaster (WebFOCUS Server procedure, Standard Report, File, FTP, and URL are the others).
TaskMyReport() - Constructor for class ibi.broker.api.data.schedule.TaskMyReport
 
taskRetry - Variable in class ibi.broker.api.data.schedule.Task
 
TaskSchedule - Class in ibi.broker.api.data.schedule
 
TaskSchedule() - Constructor for class ibi.broker.api.data.schedule.TaskSchedule
 
TaskStandardReport - Class in ibi.broker.api.data.schedule
The TaskStandardReport class is one of six task types supported by ReportCaster (WF Server Procedure, MyReport, File, FTP, and URL are the others).
TaskStandardReport() - Constructor for class ibi.broker.api.data.schedule.TaskStandardReport
 
TaskUrl - Class in ibi.broker.api.data.schedule
The TaskUrl class is one of six task types supported by ReportCaster (WF Server Procedure, MyReport, Standard Report, FTP, and File are the others).
TaskUrl() - Constructor for class ibi.broker.api.data.schedule.TaskUrl
 
TaskWFServerProcedure - Class in ibi.broker.api.data.schedule
The TaskWFServerProcedure class is one of six task types supported by ReportCaster (MyReport, Standard Report, File, FTP and URL are the others).
TaskWFServerProcedure() - Constructor for class ibi.broker.api.data.schedule.TaskWFServerProcedure
 
TERMINATE - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of TERMINATE.
testExecIdCredential(ExecId) - Method in interface ibi.broker.api.cci.UserManager
 
testExecIdCredential(ExecId) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
TimeInfo - Class in ibi.broker.api.data.schedule
The TimeInfo class is an abstract class used to represent time-related information as it pertains to scheduling within ReportCaster.
TimeInfo() - Constructor for class ibi.broker.api.data.schedule.TimeInfo
 
TimeInfoCustom - Class in ibi.broker.api.data.schedule
 
TimeInfoCustom() - Constructor for class ibi.broker.api.data.schedule.TimeInfoCustom
 
TimeInfoDay - Class in ibi.broker.api.data.schedule
The TimeInfoDay class represents time information pertaining to scheduled reports that run in intervals of days.
TimeInfoDay() - Constructor for class ibi.broker.api.data.schedule.TimeInfoDay
 
TimeInfoHour - Class in ibi.broker.api.data.schedule
The TimeInfoHour class represents time information pertaining to scheduled reports that run in intervals of hours.
TimeInfoHour() - Constructor for class ibi.broker.api.data.schedule.TimeInfoHour
 
TimeInfoMinute - Class in ibi.broker.api.data.schedule
The TimeInfoMinute class represents time information pertaining to scheduled reports that run in intervals of minutes.
TimeInfoMinute() - Constructor for class ibi.broker.api.data.schedule.TimeInfoMinute
 
TimeInfoMonth - Class in ibi.broker.api.data.schedule
The TimeInfoMonth class represents time information pertaining to scheduled reports that run in intervals of months.
TimeInfoMonth() - Constructor for class ibi.broker.api.data.schedule.TimeInfoMonth
 
TimeInfoOnce - Class in ibi.broker.api.data.schedule
The TimeInfoOnce class represents time information pertaining to scheduled jobs that are to run only once.
TimeInfoOnce() - Constructor for class ibi.broker.api.data.schedule.TimeInfoOnce
 
TimeInfoWeek - Class in ibi.broker.api.data.schedule
The TimeInfoWeek class represents time information pertaining to scheduled reports that run in intervals of weeks.
TimeInfoWeek() - Constructor for class ibi.broker.api.data.schedule.TimeInfoWeek
 
TimeInfoYear - Class in ibi.broker.api.data.schedule
The TimeInfoYear class represents time information pertaining to scheduled reports that run in intervals of years.
TimeInfoYear() - Constructor for class ibi.broker.api.data.schedule.TimeInfoYear
 
TimeInterval - Class in ibi.broker.api.data.schedule
 
TimeInterval() - Constructor for class ibi.broker.api.data.schedule.TimeInterval
 
toString() - Method in exception ibi.broker.api.data.CasterException
Obtains the string concatenation of the error code and the error message thrown by this CasterException.
toString() - Method in class ibi.broker.api.data.schedule.OptionValue
 
TRACE_DEFAULT - Static variable in class ibi.broker.api.data.schedule.Schedule
 
TRACE_NONE - Static variable in class ibi.broker.api.data.schedule.Schedule
 
TRACE_SCHEDULE - Static variable in class ibi.broker.api.data.schedule.Schedule
 
TRACE_SCHEDULE_AND_REPORT - Static variable in class ibi.broker.api.data.schedule.Schedule
 
TYPE_E - Static variable in class ibi.broker.api.data.ValidationErrorItem
 
TYPE_GROUP - Static variable in class ibi.broker.api.data.libraryaccess.AccessElement
G is a String constant that indicates a GROUP member type.
TYPE_USER - Static variable in class ibi.broker.api.data.libraryaccess.AccessElement
U is a String constant that indicates a USER member type.
TYPE_W - Static variable in class ibi.broker.api.data.ValidationErrorItem
 

U

updateAddressBook(AddrBook) - Method in interface ibi.broker.api.cci.AddressBookManager
Updates an Address Book's properties, deletes all existing distribution lists and inserts the new ones, which are represented by the DestinationElement Array stored in AddrBook.
updateAddressBook(AddrBook) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
updateAddressBook(Authenticate, AddrBook) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
updateAddressBook(Authenticate, AddrBook) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
updateAddressBookProperty(AddrBook) - Method in interface ibi.broker.api.cci.AddressBookManager
Address Book's properties in the ReportCaster Repository.
updateAddressBookProperty(AddrBook) - Method in class ibi.broker.api.ws.AddressBookManagerClientSF
 
updateAddressBookProperty(Authenticate, AddrBook) - Method in interface ibi.broker.api.ws.AddressBookManagerIF
 
updateAddressBookProperty(Authenticate, AddrBook) - Method in class ibi.broker.api.ws.AddressBookManagerWS
 
updateBlackoutDateList(BlackoutDate[], String) - Method in interface ibi.broker.api.cci.ConfigManager
 
updateExecId(ExecId) - Method in interface ibi.broker.api.cci.UserManager
 
updateExecId(ExecId) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
updateGlobalBlackoutDateList(BlackoutDate[]) - Method in interface ibi.broker.api.cci.ConfigManager
 
updateGroup(Group) - Method in interface ibi.broker.api.cci.UserManager
After modifying properties contained in the Group object (except for the group name), updates the corresponding group data in the underlying repository.
updateGroup(Group) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
updateGroup(Authenticate, Group) - Method in interface ibi.broker.api.ws.UserManagerIF
 
updateGroup(Authenticate, Group) - Method in class ibi.broker.api.ws.UserManagerWS
 
updateGroupWithUser(Group, String[]) - Method in interface ibi.broker.api.cci.UserManager
Updates a given Group with a String Array of user names representing the list of usernames belonging to the group.
updateGroupWithUser(Group, String[]) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
updateGroupWithUser(Authenticate, Group, String[]) - Method in interface ibi.broker.api.ws.UserManagerIF
 
updateGroupWithUser(Authenticate, Group, String[]) - Method in class ibi.broker.api.ws.UserManagerWS
 
updateLibraryAccessBook(LibraryAccessBook) - Method in interface ibi.broker.api.cci.LibraryAccessManager
 
updateLibraryAccessBook(LibraryAccessBook) - Method in class ibi.broker.api.ws.LibraryAccessManagerClientSF
 
updateLibraryAccessBook(Authenticate, LibraryAccessBook) - Method in interface ibi.broker.api.ws.LibraryAccessManagerIF
 
updateLibraryAccessBook(Authenticate, LibraryAccessBook) - Method in class ibi.broker.api.ws.LibraryAccessManagerWS
 
updateSchedule(Schedule) - Method in interface ibi.broker.api.cci.ScheduleManager
Updates a Schedule object which already exists in the ReportCaster repository.
updateSchedule(Schedule) - Method in class ibi.broker.api.ws.ScheduleManagerClientSF
 
updateSchedule(Authenticate, Schedule) - Method in interface ibi.broker.api.ws.ScheduleManagerIF
 
updateSchedule(Authenticate, Schedule) - Method in class ibi.broker.api.ws.ScheduleManagerWS
 
updateUser(User) - Method in interface ibi.broker.api.cci.UserManager
Updates a user's property information in the underlying repository.
updateUser(User) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
updateUser(Authenticate, User) - Method in interface ibi.broker.api.ws.UserManagerIF
 
updateUser(Authenticate, User) - Method in class ibi.broker.api.ws.UserManagerWS
 
updateUserInfoProperties(User) - Method in interface ibi.broker.api.cci.UserManager
Allows an authenticated user to change limited properties belonging to him in the underlying repository.
updateUserInfoProperties(User) - Method in class ibi.broker.api.ws.UserManagerClientSF
 
updateUserInfoProperties(Authenticate, User) - Method in interface ibi.broker.api.ws.UserManagerIF
 
updateUserInfoProperties(Authenticate, User) - Method in class ibi.broker.api.ws.UserManagerWS
 
updateWatchItem(WatchItem) - Method in class ibi.broker.api.ws.LibraryContentManagerClientSF
 
URL - Static variable in class ibi.broker.api.data.schedule.Task
Task type indicating a URL task.
URL - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
User - Class in ibi.broker.api.data.user
Allows the creation and manipulation of ReportCaster Users for the purpose of authentication and authorization.
User() - Constructor for class ibi.broker.api.data.user.User
 
User(String) - Constructor for class ibi.broker.api.data.user.User
 
UserManager - Interface in ibi.broker.api.cci
This interface handles the management of users and groups.
UserManagerClientSF - Class in ibi.broker.api.ws
 
UserManagerClientSF(String, String, String) - Constructor for class ibi.broker.api.ws.UserManagerClientSF
 
UserManagerIF - Interface in ibi.broker.api.ws
 
UserManagerWS - Class in ibi.broker.api.ws
 
UserManagerWS() - Constructor for class ibi.broker.api.ws.UserManagerWS
 

V

validate(String) - Method in class ibi.broker.api.data.dslog.DsLog
This method is used by the Distribution Server to validate certain field values before saving them to the repository, and should not be called under any circumstances by a ReportCaster API user.
validate(String) - Method in class ibi.broker.api.data.dslog.DsLogElement
This method is used by the Distribution Server to validate certain field values before saving them to the repository, and should not be called under any circumstances by a ReportCaster API user.
validate(String) - Method in class ibi.broker.api.data.library.Category
Assists in validating arguments
validate(String) - Method in class ibi.broker.api.data.library.Content
Assists in validating arguments
validate(String) - Method in class ibi.broker.api.data.library.Version
Assists in validating arguments
validate(String) - Method in class ibi.broker.api.data.libraryaccess.AccessElement
Verifies that an AccessElement String is valid.
validate(String) - Method in class ibi.broker.api.data.libraryaccess.LibraryAccessBook
Verifies that a LibraryAccessBook String is valid.
validate(String) - Method in class ibi.broker.api.data.user.Group
Assists in validating arguments
validate(String) - Method in class ibi.broker.api.data.user.User
Assists in validating arguments
ValidationErrorItem - Class in ibi.broker.api.data
 
ValidationErrorItem() - Constructor for class ibi.broker.api.data.ValidationErrorItem
 
ValidationErrorItem(String, String) - Constructor for class ibi.broker.api.data.ValidationErrorItem
 
Version - Class in ibi.broker.api.data.library
The Version class provides a means of organizing (by version) Report Library content, which exists as a result of scheduled distributions to the library.
Version() - Constructor for class ibi.broker.api.data.library.Version
 
VISDIS - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format VISDIS.
VISDISAE - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
 

W

WatchItem - Class in ibi.broker.api.data.library
 
WatchItem() - Constructor for class ibi.broker.api.data.library.WatchItem
 
WebAuthenticateCredential - Class in ibi.broker.api.cci
This class is used to pass authentication credentials from a WebServer to the CasterConnectionFactory.getConnection() method.
WebAuthenticateCredential() - Constructor for class ibi.broker.api.cci.WebAuthenticateCredential
Constructor for WebAuthenicateCredential.
WebAuthenticateCredential(String, String) - Constructor for class ibi.broker.api.cci.WebAuthenticateCredential
 
WebAuthenticateCredential(HttpServletRequest) - Constructor for class ibi.broker.api.cci.WebAuthenticateCredential
 
WEBFOCUS_SERVER_PROCEDURE - Static variable in class ibi.broker.api.data.schedule.Task
Task type indicating a WebFocus Server Procedure task.
WEBFOCUS_SERVER_PROCEDURE - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
WEEK - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of a WEEK.
WEEK - Static variable in class ibi.broker.api.data.schedule.TimeInfo
Interval type indicating execution weekly.
WEEK - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 
WK1 - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format WK1.
WP - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format WP.
writeApplicationPreferenceList(ApplicationPreference[]) - Method in interface ibi.broker.api.cci.ConfigManager
 
writeSchedulePreferenceList(SchedulePreference[]) - Method in interface ibi.broker.api.cci.ConfigManager
 

X

XML - Static variable in class ibi.broker.api.data.schedule.TaskWFServerProcedure
String identifier for send format XML.

Y

YEAR - Static variable in class ibi.broker.api.data.schedule.Alert
String identifier for Alert reset period (reset type) of a YEAR.
YEAR - Static variable in class ibi.broker.api.data.schedule.TimeInfo
Interval type indicating execution yearly.
YEAR - Static variable in interface ibi.broker.api.ws.ScheduleManagerIF
 

A B C D E F G H I J L M N O P R S T U V W X Y

Copyright © 2006 Information Builders, Incorporated.