com.crystaldecisions.sdk.occa.infostore
Interface IBatchSecurityItems

All Superinterfaces:

java.util.Collection, java.lang.Iterable, java.util.List

public interface IBatchSecurityItems
extends java.util.List

This Interface represents a collection of IBatchSecurityItem objects. It is used for checking security rights for multiple objects. Allows you to submit batch operations and minimize server load.

For information on how to check rights see the ISecurityInfo interface.

Method Summary

IBatchSecurityItem	add(int objID, int rightID) Add a IBatchSecurityItem object to the collection.
IBatchSecurityItem	add(int objID, int rightID, java.lang.String kind) Adds a IBatchSecurityItem object to the collection.
void	fetch() Fetches the batch security rights information from the server based on the IBatchSecurityItem objects stored in this collection.

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

IBatchSecurityItem add(int objID,
                       int rightID,
                       java.lang.String kind)
                       throws SDKException

Adds a IBatchSecurityItem object to the collection.

Parameters:

objID - An int that represents the ID of the InfoObject for which the right will be checked.

rightID - An int that represents the ID of the right that will be checked.

kind - A String that represents the InfoObject type of the right that will be checked.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

CeKind

add

IBatchSecurityItem add(int objID,
                       int rightID)
                       throws SDKException

Add a IBatchSecurityItem object to the collection.

Parameters:

objID - An int that represents the ID of the InfoObject for which the right will be checked.

rightID - An int that represents the ID of the right that will be checked.

Throws:

SDKException - This is thrown if the process is unsuccessful.

fetch

void fetch()
           throws SDKException

Fetches the batch security rights information from the server based on the IBatchSecurityItem objects stored in this collection. The batch security rights will then be pre-cached to improve performance.

Note: See the ISecurityInfo interface for information on how to check rights.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

ISecurityInfo.checkSystemRights(int[] rights, boolean useCache), ISecurityInfo.checkCustomRights(int[] rights, String[] kinds, boolean useCache)