Package com.crystaldecisions.sdk.occa.infostore

This package provides the ability to query for InfoObjects, as well as add, delete, and update them.

See:
Description

Interface Summary

CeScheduleType	This interface defines constant values that specify how frequently a report is to be scheduled.
CeSecurityCUID	This interface contains cluster unique CUIDs, of well known yet dynamically generated objects.
CeSecurityCUID.AppConfigObject	Identifies the unique CUIDs that are used in a query to specify the application configuration components.
CeSecurityCUID.Relation	Identifies the unique CUIDs that are used in a query to retrieve related dynamically generated objects.
CeSecurityCUID.RootFolder	Identifies the unique CUIDs that are used in a query to specify the root folder.
CeSecurityCUID.SystemObject	Identifies the unique CUIDs that are used in a query to specify the system objects.
CeSecurityID	This interface defines commonly used system constants.
CeSecurityID.Folder	The IDs of the BusinessObjects Enterprise system folders.
CeSecurityID.Limit	The IDs of the BusinessObjects Enterprise system security limits.
CeSecurityID.Right	The IDs of the BusinessObjects Enterprise system security rights.
CeSecurityID.User	Common user and group IDs.
IBatchSecurityItem	This interface represents a security item that can be checked during a batch operation.
IBatchSecurityItems	This Interface represents a collection of IBatchSecurityItem objects.
ICalendarDay	This interface is used to store the information used in calendar-based scheduling.
ICalendarRunDays	This interface allows you to create a calendar template, which is a user-defined set of days that can be used for scheduling a job.
ICategoryContent	This interface allows you to manage categories for documents and reports.
ICategoryPager	This interface defines a category pager and is based on the functionality of IPagingQueryBase.
IContainer	This interface defines generic containers that can hold any type of object.
IContent	This interface defines functions used by desktop plugins that export to a particular file type.
IDestination	This object is used to specify the output destination of a scheduled job.
IDestinationPlugin	This interface defines Destination plugins that allow reports to be scheduled to specific destinations.
IDestinations	Returns a collection of IDestination objects.
IEvents	Use this collection to schedule a job with events.
IFile	This interface represents a local or remote file object.
IFiles	This interface represents a collection of file objects.
IFolderPager	This interface defines a folder pager and is based on the functionality of the IPagingQueryBase interface.
IInfoObject	IInfoObject is the core interface for writing a BusinessObjects Enterprise object that interacts and works within the BusinessObjects Enterprise system.
IInfoObject.PropertySet	This interface defines the constants that represent properties of the IInfoObject interface.
IInfoObjects	The IInfoObjects interface defines a collection that contains InfoObjects such as Folders, Reports, and Instances, and it has a number of methods to enumerate its contents.
IInfoObjects.CopyModes	This interface specifies the copy modes for an InfoObject.
IInfoStore	The IInfoStore object accesses BusinessObjects Enterprise objects (For example, InfoObjects) such as Folders, Reports, and Instances.
ILimits	This interface defines limits which can be assigned to users.
ILocalFile	This interface represents a local file object.
INotifications	This interface is used for setting schedule notification information.
INotifications.CeAuditOnResult	Specifies the values for notification via audit.
IObjectPrincipal	This object stores a principal's security information; that is, it gives you access to the roles, rights, and limits for specific users or groups.
IObjectPrincipals	This interface contains all of the object principals (users, groups) that have explicit as well as inherited rights to a particular object.
IPagingQuery	This interface provides information about a paged result set.
IPagingQueryBase	This interface defines a paging scheme that manages the number of search results that are displayed per page and the number of pages allowed in a range.
IProcessingInfo	The IProcessingInfo interface contains a collection of properties that are used by the Job Server for processing object-specific information.
IRemoteFile	This interface represents a remote file object on the File Repository Server.
IRightID	This interface defines interactions that allow information to be obtained from object rights.
IRole	This interface defines roles that can be assigned to users.
ISchedulable	This interface manages scheduling, and it retrieves information about the instances of objects that are connected to the ISchedulable object.
ISchedulingInfo	The ISchedulingInfo interface contains a collection of properties used by the CMS to store scheduling information (for example, schedule start time information, schedule destination information, schedule dependency information).
ISchedulingInfo.GroupChoice	This interface contains constants which specify the server group on which to run scheduled reports.
ISchedulingInfo.ScheduleFlags	This interface defines the instance status flags.
ISchedulingInfo.ScheduleOutcome	This interface contains constants which indicate the result of a job after it has finished processing.
ISchedulingInfo.ScheduleStatus	This interface contains constants which specify the current status of the scheduled job.
ISecurityInfo	The ISecurityInfo interface allows you to set the security roles, rights, and limits on an object for a specific user or group.
ISecurityInfo.CeRightModes	The nested interface that defines constants that represent right modes.
ISecurityLimit	This object provides information about the limits that are set on an object for a particular principal.
ISecurityLimits	Use this collection to set limits on an object for a particular principal (user, group).
ISecurityRight	This object provides information about the rights that are set on an object for a particular principal.
ISecurityRights	Use this collection to set granular rights on an object for a particular principal (user, group).
ISendable	This Interface allows you to determine the destinations for the sendable objects.
ISortDimension	This interface defines a sort dimension.
IStreamingDownloadFile	This interface enables the use of streams during file transfer from BusinessObjects Enterprise.
IStreamingFile	This object enables you to use streaming when transferring files from BusinessObjects Enterprise.
IStreamingUploadFile	This interface uploads files to FRS in a streaming mode.
ISupportJobServer	This interface is implemented by all the plugin objects that can be processed by a Job Server.

Class Summary

CePropertyID	The public property IDs supported by InfoObjects.
SearchPattern	This class defines a search pattern for objects.
SortType	This class defines a sort type and builds on the functionality of a java.util.LinkedList.

Package com.crystaldecisions.sdk.occa.infostore Description

This package provides the ability to query for InfoObjects, as well as add, delete, and update them. The CMS, which is responsible for managing these InfoObjects, can be considered a repository or "InfoStore."

All InfoObjects implement the IInfoObject object. If they are to be scheduled and processed, the ISchedulingInfo interface and the IProcessingInfo interface can be retrieved through the corresponding IInfoObject method. The IInfoObject.getSchedulingInfo() and the IInfoObject.getProcessingInfo() methods will return the ISchedulingInfo and IProcessingInfo interfaces respectively.

The characteristics and behavior of a specific InfoObject are user defined via a specific BusinessObjects Enterprise plugin package and its interfaces.

Related Documentation

• Object Model Diagram