com.crystaldecisions.sdk.occa.infostore
Interface IPluginBasedRightIDs

public interface IPluginBasedRightIDs

This interface is used by ISecurityInfo2.getKnownRightsByPlugin to return all the right/limit ids that can be applied to an object. The rights and limits are grouped based on plugin types. Also accessible are the meta plugin rights and limits that are applicable to all plugin types.

Method Summary

IRightID[]	getMetaPluginLimits() Returns the meta plugin limits applicable to all plugin types.
IRightID[]	getMetaPluginRights() Returns the meta plugin rights applicable to all plugin types.
java.util.Map	getPluginCustomLimits() Returns a map that contains entries for all applicable plugin types and all the custom limit ids that can be applied to each plugin type.
java.util.Map	getPluginCustomRights() Returns a map that contains entries for all applicable plugin types and all the custom right ids that can be applied to each plugin type.
java.util.Map	getPluginLimits() Returns a map that contains entries for all applicable plugin types and all the limit ids, including general rights, that can be applied to each plugin type.
java.util.Map	getPluginRights() Returns a map that contains entries for all applicable plugin types and all the right ids, including general rights, that can be applied to each plugin type.

Method Detail

getMetaPluginRights

IRightID[] getMetaPluginRights()

Returns the meta plugin rights applicable to all plugin types.

Returns:

the meta plugin rights applicable to all plugin types.

getMetaPluginLimits

IRightID[] getMetaPluginLimits()

Returns the meta plugin limits applicable to all plugin types.

Returns:

the meta plugin limits applicable to all plugin types.

getPluginCustomRights

java.util.Map getPluginCustomRights()

Returns a map that contains entries for all applicable plugin types and all the custom right ids that can be applied to each plugin type. The right ids are returned as the value of each map entry of IRightID array.

Returns:

a read-only map that contains entries for all applicable plugin types and all the custom right ids that can be applied to each plugin type. The key is the plugin type which is a String representing a plugin's progid and the value is an array of IRightID.

getPluginCustomLimits

java.util.Map getPluginCustomLimits()

Returns a map that contains entries for all applicable plugin types and all the custom limit ids that can be applied to each plugin type. The limit ids are returned as the value of each map entry of IRightID array.

Returns:

a read-only map that contains entries for all applicable plugin types and all the custom limit ids that can be applied to each plugin type. The key is the plugin type which is a String representing a plugin's progid and the value is an array of IRightID.

getPluginRights

java.util.Map getPluginRights()

Returns a map that contains entries for all applicable plugin types and all the right ids, including general rights, that can be applied to each plugin type. The right ids are returned as the value of each map entry of IRightID set.

Returns:

a read-only map that contains entries for all applicable plugin types and all the right ids, including general rights, that can be applied to each plugin type. The key is the plugin type which is a String representing a plugin's progid or com.crystaldecisions.sdk.occa.security.CeSecurityOptions.ANY_OBJTYPE for Global General rights that are applicable to all other plugins. The value is a Set of IRightID.

getPluginLimits

java.util.Map getPluginLimits()

Returns a map that contains entries for all applicable plugin types and all the limit ids, including general rights, that can be applied to each plugin type. The limit ids are returned as the value of each map entry of IRightID set.

Returns:

a read-only map that contains entries for all applicable plugin types and all the right ids, including general rights, that can be applied to each plugin type. The key is the plugin type which is a String representing a plugin's progid or com.crystaldecisions.sdk.occa.security.CeSecurityOptions.ANY_OBJTYPE for Global General rights that are applicable to all other plugins. The value is a Set of IRightID.