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.LicenseRestriction
CeSecurityCUID.Relation	Identifies the unique CUIDs that are used in a query to retrieve related dynamically generated objects.
CeSecurityCUID.Role	Identifies the unique CUIDs referring to the default roles defined in the system.
CeSecurityCUID.RootFolder	Identifies the unique CUIDs that are used in a query to specify the root folder.
CeSecurityCUID.ServerIntelligence	Identifies the unique CUIDs that are used in a query to specify the Server Intelligence objects.
CeSecurityCUID.SystemObject	Identifies the unique CUIDs that are used in a query to specify the system objects.
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	To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments
ICMSQuery	Represents a CMS query that can be reused and passed to the InfoStore.
ICommitError	An interface to the information that is returned if an error is encountered during a commit to the InfoStore.
ICommitErrors	A collection of ICommitError objects that contain information on any errors that are encountered in an InfoStore commit.
ICommitResult
ICommitResultInfo	An interface to the information that is returned if a problem is encountered during a commit to the InfoStore.
ICommitWarning	An interface to the information that is returned if a warning is encountered during a commit to the InfoStore.
ICommitWarnings	A collection of ICommitWarning objects that contain information on any warnings that are encountered in an InfoStore commit.
IContainer
IContent	This interface defines functions used by desktop plugins that export to a particular file type.
IDeliverToInboxPrincipals	This is a list that store principals that represents the whom to deliver to for the DeliveryToInbox operation.
IDestination	This object is used to specify the output destination of a scheduled job.
IDestinationFormat
IDestinationFormats
IDestinationPlugin	This interface defines Destination plugins that allow reports to be scheduled to specific destinations.
IDestinationPluginArtifactFormat	This interface defines a destination plugin artifact for a source document.
IDestinationPluginArtifactFormat.CeDistributionMode	Mode of distribution.
IDestinationPluginArtifactFormats
IDestinations	Returns a collection of IDestination objects.
IDestinationStaticDocument
IDestinationStaticDocuments
IEffectiveLimit	This object provides information about an effective limit that a particular principal has on an object.
IEffectiveLimits	This collection contains the effective limits on an object for a particular principal (user, group).
IEffectivePrincipal	This interface defines the object principal (a user or a group) with effective rights to a particular object.
IEffectivePrincipals	This interface represents a collection that contains all of the principals (users and groups) that have effective rights on the current object.
IEffectiveRight	This object provides information about an effective right on an object for a particular principal.
IEffectiveRights	This interface represents a collection of effective granular rights on an object for a particular principal (user or group).
IEffectiveRole	This object provides information about a custom access level (custom role) that is effective to an object for a particular principal.
IEffectiveRoles	This interface represents a collection of effective custom access levels (custom roles) on an object for a particular principal (user or group).
IEvents	Use this collection to schedule a job with events.
IExplicitLimit	This object provides information about a limit that is assigned to an object for a particular principal.
IExplicitLimits	This interface represents a collection that contains the limits that are explicitly assigned on an object for a particular principal (user or group).
IExplicitPrincipal	This interface defines an object principal (a user or a group) with explicit rights assigned to a particular object.
IExplicitPrincipals	This interface represents a collection that contains the object principals (users and groups) that have explicit rights, limits, or roles on a particular object.
IExplicitRight	This object provides information about a right that is assigned to an object for a particular principal.
IExplicitRights	This interface represents a collection of explicit granular rights assigned to an object for a particular principal (user or group).
IExplicitRole	This object provides information about a custom access level (custom roles) that is assigned to an object for a particular principal.
IExplicitRoles	This interface represents a collection of custom access levels (custom roles) assigned to an object for a particular principal (user or group).
IFile	This interface represents a local or remote file object.
IFiles	This interface represents a collection of file objects.
IFolderPager	To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments
IFollowable	An interface to support user to follow/unfollow a document related StreamWork feeds
IInfoObject	IInfoObject is the core interface for writing a SAP BusinessObjects Enterprise object that interacts and works within the SAP BusinessObjects Enterprise system.
IInfoObject.CommitLevel	The CommitLevel interface contains constants corresponding to the commit levels that are supported for optimistic locking.
IInfoObject.Delta	Internal only.
IInfoObject.LockStatus	Internal only.
IInfoObject.PropertySet
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	IInfoStore represents the BusinessObjects Enterprise InfoStore service.
ILimits	This interface defines limits which can be assigned to users.
ILocalFile	This interface represents a local file object.
ILockInfo	Internal only.
INotifications	This interface is used for setting schedule notification information.
INotifications.CeAuditOnResult	Specifies the values for notification via audit.
IObjectPrincipal	Deprecated. Since 12.0, IObjectPrincipal has been replaced by IExplicitPrincipal and IEffectivePrincipal accessible through IExplicitPrincipals and IEffectivePrincipals respectively
IObjectPrincipals	Deprecated. Since 12.0, IObjectPrincipals has been replaced by IExplicitPrincipals and IEffectivePrincipals accessible through ISecurityInfo2 interface
IPagingQuery	Deprecated. Since 4.0.
IPagingQueryBase	Deprecated. Since 4.0.
IPluginBasedRightIDs	This interface is used by ISecurityInfo2.getKnownRightsByPlugin to return all the right/limit ids that can be applied to an object.
IPrincipalBase	This interface defines the base methods for a security principal (user, group)
IPrincipalsBase	This interface defines the collection of object principals (users, groups) that have either explicit or effective rights to a particular object.
IProcessingInfo	The IProcessingInfo interface contains a collection of properties that are used by the Job Server for processing object-specific information.
IQueryConfiguration	Represents possible options that can be passed to the CMS during a query.
IRemoteFile	This interface represents a remote file object on the File Repository Server.
IRenameRecord	This is an interface for retrieving information about InfoObjects that were renamed during a commit to the CMS through the Infostore.
IRightBase	This object provides information about a particular right on an object for a particular principal.
IRightID	This interface defines interactions that allow information to be obtained from an object right.
IRightIDBase	This interface defines a set of methods describing the elements that make up the authentic right id
IRightSource	This interface defines the source of an effective right, i.e. where the effective right is explicit set.
IRightsView	This class is for internal use only
IRightsView.FilterOp
IRightsView.RightIndex
IRightsView.RightState
IRightsView.SortType
IRole	Deprecated. Since 12.0.
IRoleID	This interface defines interactions that allow information to be obtained from a custom access level (custom role).
IRoleSource	This interface defines the source of an effective role, i.e. where the effective role is explicit set.
ISchedulable
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.
ISecurityBase
ISecurityInfo	Deprecated. Since version 12.0, ISecurityInfo has been replaced by ISecurityInfo2, which can be retrieved by calling IInfoObject.getSecurityInfo2().
ISecurityInfo.CeRightModes
ISecurityInfo2	The ISecurityInfo2 interface allows you to assign roles, rights, and limits on objects to users and user groups.
ISecurityInfoAdmin	This interface provides information about a generic security info (right, limit, or right)
ISecurityLimit	Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively
ISecurityLimitAdmin	This interface defines admin interface for security limit that extends IEffectiveLimit, IExplicitLimit, ISecurityInfoAdmin, and IRightIDBase.
ISecurityLimits	Deprecated. Since 12.0, ISecurityLimits has been replaced by IExplicitLimits and IEffectiveLimits accessible through IExplicitPrincipal and IEffectivePrincipal respectively
ISecurityPrincipal	This interface defines a principal and the security info that applies to it on a given object.
ISecurityRight	Deprecated. Since 12.0, ISecurityRight has been replaced by IExplicitRight and IEffectiveRight accessible through IExplicitRights and IEffectiveRights respectively
ISecurityRightAdmin	This interface defines admin interface for security right that extends IEffectiveRight, IExplicitRight, ISecurityInfoAdmin, and IRightIDBase.
ISecurityRights	Deprecated. Since 12.0, ISecurityRights has been replaced by IExplicitRights and IEffectiveRights accessible through IExplicitPrincipal and IEffectivePrincipal respectively
ISecurityRoleAdmin	This interface defines admin interface for security role that extends IEffectiveRole, IExplicitRole, and ISecurityInfoAdmin.
ISendable	Interface for the sendable objects
ISortDimension	Created by IntelliJ IDEA.
IStreamingDownloadFile	This object enables you to use streaming when transferring files from SAP BusinessObjects Enterprise.
IStreamingFile	Deprecated.
IStreamingQuery	This interface is used to return info objects in batches to users who query the CMS for a large set of objects.
IStreamingUploadFile
ISupportJobServer	This interface is implemented by all the plugin objects that can be processed by a Job Server.
RightsFilterCriteria.IFilterHelper
RightsSortCriteria.ISortHelper

Class Summary

CePropertyID	The public property IDs supported by InfoObjects.
CeSecurityID	This interface defines commonly used system constants.
CommitMode	This class provides a type-safe enumeration of the supported commit modes.
IInfoObject.LocaleOption	The LocaleOption indicates whether you want default, fallback, or create if not exist behaviour when you call getFiles
RightDescriptor	This class contains information about a right, including the ID, the plugin type associated with the right, the owner flag, the scope, and the applicable kind.
RightIDDescriptor	The class describes the basic information of a right as an identifier which specifies the id, the right plugin type, and the owner flag.
RightsFilterCriteria	This class is for internal use only
RightsFilterCriterion	This class is for internal use only
RightsSortCriteria	This class is for internal use only
RightsSortCriterion	This class is for internal use only
SearchPattern
SortType

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 APS, 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 plugin package and its interfaces.