com.crystaldecisions.sdk.occa.infostore
Interface IInfoObjects

All Superinterfaces:
java.util.Collection, java.util.List

public interface IInfoObjects
extends java.util.List

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. This collection is also known as a static InfoObjects collection because it is a snapshot of the query result set. The content of the collection will not change if there are updates made in the InfoStore by other applications or users.


Nested Class Summary
static interface IInfoObjects.CopyModes
          This interface specifies the copy modes for an InfoObject.
 
Method Summary
 IInfoObject add(IPluginInfo p1)
           Creates a new InfoObject.
 IInfoObject add(java.lang.String kind)
           Adds a new InfoObject to the collection based on the specified kind.
 IInfoObject copy(IInfoObject sourceObject, int mode)
           Creates a copy of the provided source InfoObject in this collection.
 void delete(IInfoObject object)
           Removes the supplied object from this collection.
 IBatchSecurityItems getBatchSecurityItems()
           Returns the IBatchSecurityItems interface that is used for checking multiple rights.
 int getResultSize()
           Returns the total number of objects that matched the query.
 void merge(IInfoObjects sourceObjects)
           Merge each of the InfoObject in SourceObjects to this collection.
 IInfoObject update(IInfoObject sourceObject)
           Updates the current object with the provided source InfoObject.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
 

Method Detail

add

public IInfoObject add(IPluginInfo p1)
                throws SDKException

Creates a new InfoObject. If p1 is null a non-typed InfoObject will be created.

Parameters:
p1 - The IPluginInfo object that defines the type of object to be created. Use the Plugin Manager to retrieve this object.
Returns:
The newly created InfoObject as an IInfoObject.
Throws:
SDKException - This exception is thrown if the process is unsuccessful.

copy

public IInfoObject copy(IInfoObject sourceObject,
                        int mode)
                 throws SDKException

Creates a copy of the provided source InfoObject in this collection.

Parameters:
mode - Specifies the copy mode to be used.
Returns:
The copy of the InfoObject as an IInfoObject.
Throws:
SDKException - This exception is thrown if the process is unsuccessful.
See Also:
IInfoObjects.CopyModes

update

public IInfoObject update(IInfoObject sourceObject)
                   throws SDKException

Updates the current object with the provided source InfoObject.

Note: This method only accepts IInfoObjects from a different deployment (cluster). Otherwise a com.crystaldecisions.sdk.exception.SDKException#SameDeployment is thrown.

Parameters:
sourceObject - Plugin Info object reference for the source object to be used in update.
Returns:
The updated InfoObject as an IInfoObject.
Throws:
SDKException - This exception is thrown if the process is unsuccessful.

merge

public void merge(IInfoObjects sourceObjects)
           throws SDKException

Merge each of the InfoObject in SourceObjects to this collection.

Note: This method only accepts IInfoObjects from the same deployment (cluster). Otherwise a com.crystaldecisions.sdk.exception.SDKException#DifferentDeployment is thrown.

Parameters:
sourceObjects - specifies the source objects to be merged into this collection.
Throws:
SDKException - This exception is thrown if the process is unsuccessful.

delete

public void delete(IInfoObject object)
            throws SDKException

Removes the supplied object from this collection.

Parameters:
object - The object to be removed from this collection. The object will be permanently removed from the InfoStore if the collection is committed.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getResultSize

public int getResultSize()

Returns the total number of objects that matched the query.

Returns:
An int representing the total number of objects that matched the query that was used to generate this collection. This number could be different from the list size if the query had a TOP N clause, or if the actual number of objects matching the query exceeds 1000.

add

public IInfoObject add(java.lang.String kind)
                throws SDKException

Adds a new InfoObject to the collection based on the specified kind. The kind represents the InfoObject type.

Parameters:
kind - A String that represents the InfoObject type.
Returns:
The newly created InfoObject as an IInfoObject.
Throws:
SDKException - This exception is thrown if the process is unsuccessful.

getBatchSecurityItems

public IBatchSecurityItems getBatchSecurityItems()
                                          throws SDKException

Returns the IBatchSecurityItems interface that is used for checking multiple rights.

Returns:
An IBatchSecurityItems interface. This interface represents a collection containing IBatchSecurityItem objects.
Throws:
SDKException