com.crystaldecisions.sdk.occa.infostore
Interface IProcessingInfo

public interface IProcessingInfo

The IProcessingInfo interface contains a collection of properties that are used by the Job Server for processing object-specific information. For example, the IProcessingInfo interface can be used to store a Report object's selection formula, prompt, and input/output directory information.

This collection of properties is also used when scheduling objects . However, while all objects that can be scheduled have the same scheduling properties, they have their own set of processing properties. In SAP BusinessObjects Enterprise, IReport, IProgram, and IObjectPackage interfaces can be scheduled. Note that if the InfoObject cannot be scheduled and thus, cannot be "processed", the object will return null.

It is recommended that for manipulating Report processing properties, you use the IReportProcessingInfo interface instead of manipulating the ProcessingInfo properties directly.

See Also:

ISchedulingInfo, IReportProcessingInfo

Method Summary

java.util.List	getProcessedRunLocales() Returns the processed run locales.
IProperties	properties() Returns an enumeration of the properties set within this property bag.

Method Detail

properties

IProperties properties()

Returns an enumeration of the properties set within this property bag.

Returns:

An IProperties object containing and enumeration of the properties set within this property bag.

getProcessedRunLocales

java.util.List getProcessedRunLocales()
                                      throws SDKException

Returns the processed run locales. An example might be a report running with SI_RUN_LOCALES="en_US","en_CA","fr_FR","de_DE","default", where SI_FALLBACK_LOCALE="jp_JP". In this case, supposing de_DE fails to run (for whatever reason) and en_CA falls back to en_US, SI_PROCESSED_LOCALES should contain "en_US","en_US","fr_FR","","jp_JP". Then this method will return the items in SI_RUN_LOCALES which got successfully processed (non empty string items in SI_PROCESSED_LOCALES), in this case "en_US", "en_CA", "fr_FR", "jp_JP". (in case the run locale is default, we display the actual processed locale)

Returns:

A List containing the processed run locales

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_RUN_LOCALES, SI_PROCESSED_LOCALES