public interface

IDSSXMLScheduleServer

com.microstrategy.webapi.IDSSXMLScheduleServer

Class Overview

The IDSSXMLScheduleServer interface is used to schedule, unschedule, and view the schedules of reports, documents, or cache expirations.

Summary

Public Methods
abstract String GetScheduleDetail(String sessionID, String scheduleXML)
This method returns the detail of a schedule defined by the ScheduleXML passed in.
abstract String GetSchedules(String sessionID, String filterXML, int blockBegin, int blockCount)
This method retrieves existing schedules.
abstract String GetSchedules2(String sessionID, String filterXML, int flags, int blockBegin, int blockCount)
This method retrieves existing schedules while passing a flag parameter.
abstract String GetTriggerByTimePattern(String sessionID, int options, boolean includeExpired, int monthValue, int monthRecurrence, int weekValue, int weekRecurrence, int dayValue, int dayRecurrence, int dayOfWeekValue, int dayOfWeekRecurrence, int hourValue, int hourRecurrence)
This method return platform hidden time-based triggers defined in MD by the trigger time definition@return
abstract String GetTriggers(String sessionID, int options)
This method returns a list of triggers that can be used for scheduling purposes.
abstract String GetTriggers(String sessionID, int options, boolean includeExpired, String id, int type, String projectId)
This method returns a lit of triggers defined in the MD, with an option to include Expired triggers
abstract String GetTriggers(String sessionID, int options, boolean includeExpired)
This method returns a lit of triggers defined in the MD, with an option to include Expired triggers
abstract void Schedule(String sessionID, String scheduleXML)
This method creates the schedule(s) defined by the ScheduleXML.
abstract void Unschedule(String sessionID, String scheduleXML)
This method deletes the schedule(s) defined by the ScheduleXML.
abstract void deleteScheduledMaintenance(String sessionID, String id, String name, String userID, String userName, WebProject project, String triggerID, int cmdID, boolean mobile, String timeAndPara)
This method is to delete an existing scheduled maintenance.
abstract String getScheduledMaintenance(String sessionID, String userID, String projectID, String triggerID, String contentID, int flag, int sff)
This method retrieves existing scheduled maintenances.
abstract void saveScheduledMaintenance(String sessionID, String userID, String userName, WebProject project, String triggerID, int cmdID, boolean mobile, String timeAndPara)
This method is to create a new scheduled maintenance.

Public Methods

public abstract String GetScheduleDetail (String sessionID, String scheduleXML)

This method returns the detail of a schedule defined by the ScheduleXML passed in.

Parameters
sessionID A valid Session ID.
scheduleXML An XML definition of a schedule.
Returns
  • A schedule XML string with detailed information (including personalization)
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetSchedules (String sessionID, String filterXML, int blockBegin, int blockCount)

This method retrieves existing schedules. The schedules to be retrieved are restricted by the FilterXML parameter.

Parameters
sessionID A valid session ID.
filterXML The filtering condition for the schedules to be retrieved in XML format.
blockBegin Defines the beginning of the schedule list being returned. This is used for incremental fetch.
blockCount Defines the number of items in the schedule list to return. This is used for incremental fetch.
Returns
  • An XML string which contains the schedule definitions requested.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetSchedules2 (String sessionID, String filterXML, int flags, int blockBegin, int blockCount)

This method retrieves existing schedules while passing a flag parameter. The schedules to be retrieved are restricted by the FilterXML parameter.

Parameters
sessionID A valid session ID.
filterXML The filtering condition for the schedules to be retrieved in XML format.
flags The flags to use when obtaining schedule details, from EnumDSSXMLGetScheduleFlags.
blockBegin Defines the beginning of the schedule list being returned. This is used for incremental fetch.
blockCount Defines the number of items in the schedule list to return. This is used for incremental fetch.
Returns
  • An XML string which contains the schedule definitions requested.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetTriggerByTimePattern (String sessionID, int options, boolean includeExpired, int monthValue, int monthRecurrence, int weekValue, int weekRecurrence, int dayValue, int dayRecurrence, int dayOfWeekValue, int dayOfWeekRecurrence, int hourValue, int hourRecurrence)

This method return platform hidden time-based triggers defined in MD by the trigger time definition@return

Parameters
sessionID A valid session ID
options Options to control the final result. This value comes from EnumDSSXMLTriggerOptions.
includeExpired Boolean to include expired triggers.
monthValue Month value of trigger definition
monthRecurrence Month recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
weekValue Week value of trigger definition
weekRecurrence Week recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
dayValue Day value of trigger definition
dayRecurrence Day recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
dayOfWeekValue Day Of Week value of trigger definition
dayOfWeekRecurrence Day Of Week recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
hourValue Hour value of trigger definition
hourRecurrence Hour recurrence type of trigger definition. This value comes form EnumDSSXMLTimeOccurrenceType.
Throws
MSTRWebAPIException

public abstract String GetTriggers (String sessionID, int options)

This method returns a list of triggers that can be used for scheduling purposes.

Parameters
sessionID A valid Session ID.
options Options to control the final result. This value comes from EnumDSSXMLTriggerOptions.
Returns
  • An XML String corresponding to the list of triggers.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetTriggers (String sessionID, int options, boolean includeExpired, String id, int type, String projectId)

This method returns a lit of triggers defined in the MD, with an option to include Expired triggers

Parameters
sessionID A valid Session ID.
options Options to control the final result. This value comes from EnumDSSXMLTriggerOptions.
includeExpired Boolean to include expired triggers.
id project id
type Object type for the target
Returns
  • An XML String corresponding to the list of triggers.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetTriggers (String sessionID, int options, boolean includeExpired)

This method returns a lit of triggers defined in the MD, with an option to include Expired triggers

Parameters
sessionID A valid Session ID.
options Options to control the final result. This value comes from EnumDSSXMLTriggerOptions.
includeExpired Boolean to include expired triggers.
Returns
  • An XML String corresponding to the list of triggers.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void Schedule (String sessionID, String scheduleXML)

This method creates the schedule(s) defined by the ScheduleXML.

Parameters
sessionID A valid session ID.
scheduleXML Definition of the schedule to be added in XML format.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void Unschedule (String sessionID, String scheduleXML)

This method deletes the schedule(s) defined by the ScheduleXML.

Parameters
sessionID A valid session ID.
scheduleXML Definition of the schedule to be removed in XML format. To unschedule a request, a user does not have to pass all the information passed while scheduling the request. He only needs to pass what the GetSchedules request returns. For example, in the case of a report schedule, we don’t need the personalization info to delete the schedule (personalization is not returned by the GetSchedules call).
Throws
MSTRWebAPIException Signals an error condition.

public abstract void deleteScheduledMaintenance (String sessionID, String id, String name, String userID, String userName, WebProject project, String triggerID, int cmdID, boolean mobile, String timeAndPara)

This method is to delete an existing scheduled maintenance.

Throws
MSTRWebAPIException Signals an error condition.

public abstract String getScheduledMaintenance (String sessionID, String userID, String projectID, String triggerID, String contentID, int flag, int sff)

This method retrieves existing scheduled maintenances. The schedule maintenances to be retrieved are restricted by the FilterXML parameter.

Parameters
flag comes from EnumDSSXMLGetScheduleFlags
sff comes from EnumDSSXMLScheduleFilterFlags
Returns
  • A schedule XML string with detailed information (including personalization)
Throws
MSTRWebAPIException Signals an error condition.

public abstract void saveScheduledMaintenance (String sessionID, String userID, String userName, WebProject project, String triggerID, int cmdID, boolean mobile, String timeAndPara)

This method is to create a new scheduled maintenance.

Throws
MSTRWebAPIException Signals an error condition.