ibi.broker.api.ws
Class LogManagerClientSF

java.lang.Object
  ibi.broker.api.ws.LogManagerClientSF

All Implemented Interfaces:

LogManager

public class LogManagerClientSF
extends java.lang.Object
implements LogManager

Constructor Summary

LogManagerClientSF(java.lang.String base, java.lang.String userName, java.lang.String password)

Method Summary

void	deleteLogByJobId(java.lang.String jobId) Deletes a specific log record as identified by its unique job ID from the underlying repository.
int	deleteLogList(java.util.Calendar startTime, java.util.Calendar endTime) 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.
int	deleteLogListByOwner(java.lang.String owner, java.util.Calendar startTime, java.util.Calendar endTime) 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.
void	deleteLogListByScheduleId(java.lang.String scheduleId) Deletes log records from the underlying ReportCaster repository associated with a specified schedule as identified by the passed scheduleId.
void	deleteLogListByScheduleIdByCalendar(java.lang.String scheduleId, java.util.Calendar startTime, java.util.Calendar endTime) 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.
DsLog	getLastLogByScheduleId(java.lang.String scheduleId) Retrieves a DsLog object, the components of which are taken from the ReportCaster repository as identified by the specified scheduleId (see Schedule.getId()).
DsLog	getLogByJobId(java.lang.String jobId) Retrieves a DsLog object, the components of which are taken from the underlying ReportCaster repository as identified by the specified jobId.
DsLog[]	getLogInfoListByOwner(java.lang.String owner) Retrieves an Array of partially setDslog objects for a specified owner (ie, logs of all schedule runs for a designated owner).
DsLog[]	getLogInfoListByOwnerByCalendar(java.lang.String owner, java.util.Calendar startTime, java.util.Calendar endTime) 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).
DsLog[]	getLogInfoListByScheduleId(java.lang.String scheduleId) Retrieves an Array of partially set Dslog objects for a specified scheduleId (ie, logs for all the runs of a designated schedule).
DsLog[]	getLogListByScheduleId(java.lang.String scheduleId)
java.lang.String[]	getOwnerList() Retrieves a String Array representing the schedule owner list from the ReportCaster repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogManagerClientSF

public LogManagerClientSF(java.lang.String base,
                          java.lang.String userName,
                          java.lang.String password)
                   throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getOwnerList

public java.lang.String[] getOwnerList()
                                throws CasterException

Description copied from interface: LogManager

Retrieves a String Array representing the schedule owner list from the ReportCaster repository. The owner list contains the usernames of individuals who have created schedules or have the right to create schedules in ReportCaster. This method is only available to the administrator.

Specified by:

getOwnerList in interface LogManager

Returns:

String array (String[] ) of schedule owners.

Throws:

CasterException - If a database access error occurs or there is no permission to access this method.

getLogByJobId

public DsLog getLogByJobId(java.lang.String jobId)
                    throws CasterException

Description copied from interface: LogManager

Retrieves a DsLog object, the components of which are taken from the underlying ReportCaster repository as identified by the specified jobId. The jobId uniquely identifies a log record for a scheduled distribution in the repository. This method is only available to the administrator and the Log owner.

Specified by:

getLogByJobId in interface LogManager

Parameters:

jobId - unique identifier of the Dslog instance.

Returns:

A DsLog object.

Throws:

CasterException - If a database access error occurs or DsLog with processId doesn't exist or there is no permission to access this method.

getLastLogByScheduleId

public DsLog getLastLogByScheduleId(java.lang.String scheduleId)
                             throws CasterException

Description copied from interface: LogManager

Retrieves a DsLog object, the components of which are taken from the ReportCaster repository as identified by the specified scheduleId (see Schedule.getId()). This method returns only that instance of Dslog that has the most recent timestamp as represented by the startTime (see Dslog.getStartTime() of the schedule. This method is only available to the administrator and the Log owner.

Specified by:

getLastLogByScheduleId in interface LogManager

Parameters:

scheduleId - The identifier of a specific Schedule.

Returns:

A DsLog object.

Throws:

CasterException - If a database access error occurs or DsLog with scheduleId doesn't exist or there is no permission to access this method.

getLogInfoListByScheduleId

public DsLog[] getLogInfoListByScheduleId(java.lang.String scheduleId)
                                   throws CasterException

Description copied from interface: LogManager

Retrieves an Array of partially set Dslog objects for a specified scheduleId (ie, logs for all the runs of a designated schedule). Although each DsLog parent object potentially has many associated DsLogElement children, for the purposes of performance the values of the DsLogElements associated with Dslog are set to NULL within this method. This method is only available to the administrator and the Log owner.

Specified by:

getLogInfoListByScheduleId in interface LogManager

Parameters:

scheduleId - The unique identifier of a Schedule.

Returns:

Array of partial DsLog objects (DsLog[]).

Throws:

CasterException - If a database access error occurs or A log with scheduleId doesn't exist or there is no permission to access this method.

getLogListByScheduleId

public DsLog[] getLogListByScheduleId(java.lang.String scheduleId)
                               throws CasterException

Specified by:

getLogListByScheduleId in interface LogManager

Throws:

CasterException

getLogInfoListByOwner

public DsLog[] getLogInfoListByOwner(java.lang.String owner)
                              throws CasterException

Description copied from interface: LogManager

Retrieves an Array of partially setDslog objects for a specified owner (ie, logs of all schedule runs for a designated owner). Although each DsLog parent object potentially has many associated DsLogElement children, for the purposes of performance the values of the DsLogElements associated with Dslog are set to NULL within this method. This method is only available to the administrator and the Log owner.

Specified by:

getLogInfoListByOwner in interface LogManager

Parameters:

owner - ReportCaster username of schedule owner.

Returns:

Array of partial DsLog objects (DsLog[]).

Throws:

CasterException - If a database access error occurs or the owner doesn't or there is no permission to access this method.

getLogInfoListByOwnerByCalendar

public DsLog[] getLogInfoListByOwnerByCalendar(java.lang.String owner,
                                               java.util.Calendar startTime,
                                               java.util.Calendar endTime)
                                        throws CasterException

Description copied from interface: 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). Although each DsLog parent object potentially has many associated DsLogElement children, for the purposes of performance the values of the DsLogElements associated with Dslog are set to NULL within this method. If startTime = NULL this retrieves all log records before endTime. If endTime = NULL this retrieves all log records after startTime. This method is only available to the administrator and the Log owner.

Specified by:

getLogInfoListByOwnerByCalendar in interface LogManager

Parameters:

owner - ReportCaster username of schedule owner.

startTime - Start position of time interval.

endTime - End position of time interval.

Returns:

Array of (DsLog[]) objects.

Throws:

CasterException - If a database access error occur, the owner doesn't exist or there is no permission to access this method.

deleteLogListByScheduleId

public void deleteLogListByScheduleId(java.lang.String scheduleId)
                               throws CasterException

Description copied from interface: LogManager

Deletes log records from the underlying ReportCaster repository associated with a specified schedule as identified by the passed scheduleId. This method is only available to the administrator and the Log owner.

Specified by:

deleteLogListByScheduleId in interface LogManager

Parameters:

scheduleId - The unique schedule identifier.

Throws:

CasterException - If a database access error occurs or scheduleId doesn't exist or there is no permission to delete this log.

deleteLogByJobId

public void deleteLogByJobId(java.lang.String jobId)
                      throws CasterException

Description copied from interface: LogManager

Deletes a specific log record as identified by its unique job ID from the underlying repository. This method is only available to the administrator and the Log owner.

Specified by:

deleteLogByJobId in interface LogManager

Parameters:

jobId - The unique identifier for a log record.

Throws:

CasterException - If a database access error occurs or the processId doesn't exist or there is no permission to delete this log.

deleteLogList

public int deleteLogList(java.util.Calendar startTime,
                         java.util.Calendar endTime)
                  throws CasterException

Description copied from interface: 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. If startTime = NULL all log records are deleted before endTime. If endTime = NULL all log records are deleted after startTime. This method is only available to the administrator.

Specified by:

deleteLogList in interface LogManager

Parameters:

startTime - Start position of time interval.

endTime - End position of time interval.

Throws:

CasterException - If a database access error occurs or there is no permission to delete this log.

deleteLogListByOwner

public int deleteLogListByOwner(java.lang.String owner,
                                java.util.Calendar startTime,
                                java.util.Calendar endTime)
                         throws CasterException

Description copied from interface: 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. If startTime = NULL all log records are deleted before endTime. If endTime = NULL all log records are deleted after startTime. This method is only available to the administrator and the Log owner.

Specified by:

deleteLogListByOwner in interface LogManager

Parameters:

owner - User ID of the owner of the schedules to be deleted.

startTime - Start position of time interval.

endTime - End position of time interval.

Throws:

CasterException - If a database access error occurs or there is no permission to delete this log.

deleteLogListByScheduleIdByCalendar

public void deleteLogListByScheduleIdByCalendar(java.lang.String scheduleId,
                                                java.util.Calendar startTime,
                                                java.util.Calendar endTime)
                                         throws CasterException

Description copied from interface: 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. If startTime = NULL all log records are deleted before endTime. If endTime = NULL all log records are deleted after startTime. This method is only available to the administrator and the Log owner.

Specified by:

deleteLogListByScheduleIdByCalendar in interface LogManager

startTime - Start position of time interval.

endTime - End position of time interval.

Throws:

CasterException - If a database access error occurs or there is no permission to delete this log.