com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class ChangePrivileges

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.ChangePrivileges

All Implemented Interfaces:

GPTool

public class ChangePrivileges
extends AbstractGPTool

Establishes or changes user access privileges to the input ArcSDE datasets, stand-alone feature classes, or tables. The Change Privileges tool is contained in the Data Management Tools tool box.

Usage tips:

• To edit ArcSDE datasets, both the View and Edit parameters must be granted. Edit privileges are dependent on the View privilege, since you cannot edit what you cannot see (view).
• Edit privileges may be revoked, but you can still view the dataset. However, if the View privilege is revoked, the Edit privileges will automatically be revoked as well.
• The possible privilege combinations and their outcome are as follows:
• The relational database management system (RDBMS) equivalent command for the View parameter is Select.
• The RDBMS equivalent commands for the Edit parameter are Update, Insert, and Delete. All three are granted or revoked simultaneously by the Edit parameter.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ChangePrivileges()
Creates the Change Privileges tool with defaults.

ChangePrivileges(Object inDataset, String user)
Creates the Change Privileges tool with the required parameters.

Method Summary

String	getEdit() Returns the Edit (Update/Insert/Delete) parameter of this tool .
Object	getInDataset() Returns the Input Dataset parameter of this tool .
Object	getOutDataset() Returns the Output Dataset parameter of this tool (Read only).
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
String	getUser() Returns the User parameter of this tool .
String	getView() Returns the View (Select) parameter of this tool .
void	setEdit(String edit) Sets the Edit (Update/Insert/Delete) parameter of this tool .
void	setInDataset(Object inDataset) Sets the Input Dataset parameter of this tool .
void	setUser(String user) Sets the User parameter of this tool .
void	setView(String view) Sets the View (Select) parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangePrivileges

public ChangePrivileges()

Creates the Change Privileges tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

ChangePrivileges

public ChangePrivileges(Object inDataset,
                        String user)

Creates the Change Privileges tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inDataset - the datasets, feature classes, or tables whose access privileges will be changed.

user - the database username whose privileges are being modified.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Dataset parameter of this tool . This parameter is the datasets, feature classes, or tables whose access privileges will be changed. This is a required parameter.

Returns:

the Input Dataset

setInDataset

public void setInDataset(Object inDataset)

Sets the Input Dataset parameter of this tool . This parameter is the datasets, feature classes, or tables whose access privileges will be changed. This is a required parameter.

Parameters:

inDataset - the datasets, feature classes, or tables whose access privileges will be changed.

getUser

public String getUser()

Returns the User parameter of this tool . This parameter is the database username whose privileges are being modified. This is a required parameter.

Returns:

the User

setUser

public void setUser(String user)

Sets the User parameter of this tool . This parameter is the database username whose privileges are being modified. This is a required parameter.

Parameters:

user - the database username whose privileges are being modified.

getView

public String getView()

Returns the View (Select) parameter of this tool . This is an optional parameter.

Returns:

the View (Select)

setView

public void setView(String view)

Sets the View (Select) parameter of this tool . This is an optional parameter.

Parameters:

view - null

getEdit

public String getEdit()

Returns the Edit (Update/Insert/Delete) parameter of this tool . This is an optional parameter.

Returns:

the Edit (Update/Insert/Delete)

setEdit

public void setEdit(String edit)

Sets the Edit (Update/Insert/Delete) parameter of this tool . This is an optional parameter.

Parameters:

edit - null

getOutDataset

public Object getOutDataset()

Returns the Output Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Dataset

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias