com.esri.arcgis.server
Interface IRoleStore

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRoleStoreProxy

public interface IRoleStore
extends java.io.Serializable

COM Interface 'IRoleStore'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriServer.olb'

Description: 'An interface to access the role repository.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID5ac20c1a_cf77_44c7_9eae_7bcd859e5ab8
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addRole(IRole pRole) Add a new role to the role store.
void	addUsersToRole(java.lang.String rolename, java.lang.String[] usernames) Adds users to a role.
void	assignRoles(java.lang.String userName, java.lang.String[] rolenames) Assigns roles to a user.
void	deleteRole(java.lang.String rolename) Deletes a role from role store.
boolean	getAllRoles(java.lang.String filter, int maxCount, IRole[][] roles) Returns a maxCount of roles from the role store that match a particular filter.
boolean	getAllRolesPaged(int startIndex, int pageSize, IRole[][] roles) Returns a pageSize of roles from the role store from the startIndex.
IRole	getRole(java.lang.String rolename) Returns a role from the role store.
boolean	getRolesForUser(java.lang.String userName, java.lang.String filter, int maxCount, java.lang.String[][] rolenames) Returns roles assigned to a user that match a filter upto a maxCount number.
int	getTotalRoles() Returns the total number of roles in the role store.
boolean	getUsersWithinRole(java.lang.String rolename, java.lang.String filter, int maxCount, java.lang.String[][] usernames) Returns users within a role that match a filter upto a maxCount number.
void	initialize(IPropertySet pProps) Connects to a role store.
boolean	isReadOnly() Tests the connection to the role store.
void	removeRoles(java.lang.String userName, java.lang.String[] rolenames) Removes roles assigned to a user.
void	removeUsersFromRole(java.lang.String rolename, java.lang.String[] usernames) Removes users from a role.
void	testConnection(IPropertySet pProps) Tests the connection to the role store.
void	updateRole(IRole pRole) Update an existing role in the role store.

Field Detail

IID5ac20c1a_cf77_44c7_9eae_7bcd859e5ab8

static final int IID5ac20c1a_cf77_44c7_9eae_7bcd859e5ab8

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

testConnection

void testConnection(IPropertySet pProps)
                    throws java.io.IOException,
                           AutomationException

Tests the connection to the role store.

Parameters:

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(IPropertySet pProps)
                throws java.io.IOException,
                       AutomationException

Connects to a role store.

Parameters:

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadOnly

boolean isReadOnly()
                   throws java.io.IOException,
                          AutomationException

Tests the connection to the role store.

Returns:

The isReadOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRole

void addRole(IRole pRole)
             throws java.io.IOException,
                    AutomationException

Add a new role to the role store.

Parameters:

pRole - A reference to a com.esri.arcgis.server.IRole (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateRole

void updateRole(IRole pRole)
                throws java.io.IOException,
                       AutomationException

Update an existing role in the role store.

Parameters:

pRole - A reference to a com.esri.arcgis.server.IRole (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRole

void deleteRole(java.lang.String rolename)
                throws java.io.IOException,
                       AutomationException

Deletes a role from role store.

Parameters:

rolename - The rolename (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRole

IRole getRole(java.lang.String rolename)
              throws java.io.IOException,
                     AutomationException

Returns a role from the role store.

Parameters:

rolename - The rolename (in)

Returns:

A reference to a com.esri.arcgis.server.IRole

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalRoles

int getTotalRoles()
                  throws java.io.IOException,
                         AutomationException

Returns the total number of roles in the role store.

Returns:

The totalRoles

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllRoles

boolean getAllRoles(java.lang.String filter,
                    int maxCount,
                    IRole[][] roles)
                    throws java.io.IOException,
                           AutomationException

Returns a maxCount of roles from the role store that match a particular filter.

Parameters:

filter - The filter (in)

maxCount - The maxCount (in)

roles - A reference to a com.esri.arcgis.server.IRole array (out: use single element array)

Returns:

The hasMore

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllRolesPaged

boolean getAllRolesPaged(int startIndex,
                         int pageSize,
                         IRole[][] roles)
                         throws java.io.IOException,
                                AutomationException

Returns a pageSize of roles from the role store from the startIndex.

Parameters:

startIndex - The startIndex (in)

pageSize - The pageSize (in)

roles - A reference to a com.esri.arcgis.server.IRole array (out: use single element array)

Returns:

The hasMore

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assignRoles

void assignRoles(java.lang.String userName,
                 java.lang.String[] rolenames)
                 throws java.io.IOException,
                        AutomationException

Assigns roles to a user.

Parameters:

userName - The userName (in)

rolenames - The rolenames (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeRoles

void removeRoles(java.lang.String userName,
                 java.lang.String[] rolenames)
                 throws java.io.IOException,
                        AutomationException

Removes roles assigned to a user.

Parameters:

userName - The userName (in)

rolenames - The rolenames (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRolesForUser

boolean getRolesForUser(java.lang.String userName,
                        java.lang.String filter,
                        int maxCount,
                        java.lang.String[][] rolenames)
                        throws java.io.IOException,
                               AutomationException

Returns roles assigned to a user that match a filter upto a maxCount number.

Parameters:

userName - The userName (in)

filter - The filter (in)

maxCount - The maxCount (in)

rolenames - The rolenames (out: use single element array)

Returns:

The hasMore

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUsersWithinRole

boolean getUsersWithinRole(java.lang.String rolename,
                           java.lang.String filter,
                           int maxCount,
                           java.lang.String[][] usernames)
                           throws java.io.IOException,
                                  AutomationException

Returns users within a role that match a filter upto a maxCount number.

Parameters:

rolename - The rolename (in)

filter - The filter (in)

maxCount - The maxCount (in)

usernames - The usernames (out: use single element array)

Returns:

The hasMore

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addUsersToRole

void addUsersToRole(java.lang.String rolename,
                    java.lang.String[] usernames)
                    throws java.io.IOException,
                           AutomationException

Adds users to a role.

Parameters:

rolename - The rolename (in)

usernames - The usernames (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeUsersFromRole

void removeUsersFromRole(java.lang.String rolename,
                         java.lang.String[] usernames)
                         throws java.io.IOException,
                                AutomationException

Removes users from a role.

Parameters:

rolename - The rolename (in)

usernames - The usernames (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.