UserRight (java-api 21.0.12 API)

java.lang.Object
- com.uc4.api.objects.UserRight

All Implemented Interfaces:

Rights
```
public class UserRight
extends java.lang.Object
implements Rights
```
This class represents a row on the authorizations tab of an USER object.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UserRight.Type
User rights.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserRight.Type` User rights.

Constructor Summary

Constructors
Modifier Constructor and Description

UserRight()
Creates a new instance of UserRight.

protected UserRight(com.uc4.util.XMLDocument doc, org.w3c.dom.Element el)

Constructors
Modifier	Constructor and Description
	`UserRight()` Creates a new instance of `UserRight`.
`protected`	`UserRight(com.uc4.util.XMLDocument doc, org.w3c.dom.Element el)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getFileNameDestination()` Returns the filter for file names.
`java.lang.String`	`getFileNameSource()` Returns the filter for file names.
`int`	`getGrp()` Returns the authorization group or `-1` if NOT is selected.
`java.lang.String`	`getHost()` Returns the filter for Agent names.
`java.lang.String`	`getHostDestination()` Returns the filter for Agent names.
`java.lang.String`	`getLogin()` Returns the filter for names of Login objects.
`java.lang.String`	`getLoginDestination()` Returns the filter for names of Login objects.
`java.lang.String`	`getName()` Returns the filter for object name and folder path.
`UserRight.Type`	`getType()` Returns the object type.
`boolean`	`isCancel()` Returns the access method: Cancel.
`boolean`	`isDefineSLA()` Access method: Define SLA.
`boolean`	`isDelete()` Returns the access method: Delete.
`boolean`	`isExecute()` Returns the access method: Execute.
`protected boolean`	`isModified()`
`boolean`	`isModifyAtRuntime()` Access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
`boolean`	`isRead()` Returns the access method: Read.
`boolean`	`isReport()` Access to Reports.
`boolean`	`isStatistics()` Access to Statistics.
`boolean`	`isWrite()` Returns the access method: Write.
`protected void`	`save(org.w3c.dom.Element row)`
`void`	`setCancel(boolean cancel)` Sets the access method: Cancel.
`void`	`setDefineSLA(boolean defineSLA)` Sets the access method: Define SLA.
`void`	`setDelete(boolean delete)` Sets the access method: Delete.
`void`	`setExecute(boolean execute)` Sets the access method: Execute.
`void`	`setFileNameDestination(java.lang.String fileNameDestination)` Sets the filter for file names (FileTransfer destination).
`void`	`setFileNameSource(java.lang.String fileNameSource)` Sets the filter for file names (FileTransfer source).
`void`	`setGrp(int grp)` Sets the authorization group.
`void`	`setHost(java.lang.String host)` Sets the filter for an Agent name (Job execution, FileTransfer source).
`void`	`setHostDestination(java.lang.String hostDestination)` Sets the filter for Agent names (FileTransfer destination).
`void`	`setLogin(java.lang.String login)` Sets the filter for names of Login objects (Job execution, FileTransfer) source).
`void`	`setLoginDestination(java.lang.String loginDestination)` Sets the filter for names of Login objects (FileTransfer destination).
`protected void`	`setModified(boolean b)`
`void`	`setModifyAtRuntime(boolean modifyAtRuntime)` Sets the access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
`void`	`setName(java.lang.String name)` Sets the filter for object name and folder path.
`void`	`setRead(boolean read)` Sets the access method: Read.
`void`	`setReport(boolean report)` Sets access to Reports.
`void`	`setStatistics(boolean statistics)` Sets access to Statistics.
`void`	`setType(UserRight.Type type)` Sets the object type.
`void`	`setWrite(boolean write)` Sets the access method: Write.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UserRight
```
public UserRight()
```
    Creates a new instance of UserRight. The group is set to "1" and the type to "*".
  - UserRight
```
protected UserRight(com.uc4.util.XMLDocument doc,
                    org.w3c.dom.Element el)
```
- Method Detail
  - save
```
protected void save(org.w3c.dom.Element row)
```
  - getType
```
public UserRight.Type getType()
```
    Returns the object type.
    
    Returns:
    
    Type
  - setType
```
public void setType(UserRight.Type type)
```
    Sets the object type.
    
    Parameters:
    
    type - Type
  - getGrp
```
public int getGrp()
```
    Returns the authorization group or -1 if NOT is selected.
    
    Returns:
    
    Authorization group
  - setGrp
```
public void setGrp(int grp)
```
    Sets the authorization group. The value -1 can be used to set the Group to "NOT". Access rights are expressed in the authorization groups 1 to 9. These groups are all on the same level. The numbers are only used to distinguish the particular groups. All access rights of the same authorization groups are connected to each other via a logical OR. Access rights defined for an authorization group thus sum up. All access rights of different authorization groups are connected via a logical AND. Only accesses for which access authorization was granted in all authorization groups are allowed. "NOT" stands for access denial. It does not depend on an authorization group and applies in all cases.
    
    Parameters:
    
    grp - Authorization group
  - getName
```
public java.lang.String getName()
```
    Returns the filter for object name and folder path.
    
    Returns:
    
    Name
  - setName
```
public void setName(java.lang.String name)
```
    Sets the filter for object name and folder path. The wildcard characters "*" and "?" may be used. "?" stands for exactly one, while "*" stands for any number of characters. This field may also include more than one filter. Several filters must be separated by commas.
    
    Parameters:
    
    name - maximum 200 characters
  - getHost
```
public java.lang.String getHost()
```
    Returns the filter for Agent names.
    
    Returns:
    
    Agent name
  - setHost
```
public void setHost(java.lang.String host)
```
    Sets the filter for an Agent name (Job execution, FileTransfer source). The wildcard characters "*" and "?" may be used. This field may also include more than one filter. Several filters must be separated by commas.
    
    Parameters:
    
    host - maximum 200 characters
  - getLogin
```
public java.lang.String getLogin()
```
    Returns the filter for names of Login objects.
    
    Returns:
    
    Name of Login Objects.
  - setLogin
```
public void setLogin(java.lang.String login)
```
    Sets the filter for names of Login objects (Job execution, FileTransfer) source). The wildcard characters "*" and "?" may be used. This field may also include more than one filter. Several filters must be separated by commas.
    
    Parameters:
    
    login - maximum 200 characters
  - getFileNameSource
```
public java.lang.String getFileNameSource()
```
    Returns the filter for file names.
    
    Returns:
    
    File transfer source
  - setFileNameSource
```
public void setFileNameSource(java.lang.String fileNameSource)
```
    Sets the filter for file names (FileTransfer source). The wildcard characters "*" and "?" may be used. This field may also include more than one filter. Several filters must be separated by commas.
    
    Parameters:
    
    fileNameSource - maximum 255 characters
  - getFileNameDestination
```
public java.lang.String getFileNameDestination()
```
    Returns the filter for file names.
    
    Returns:
    
    File Transfer destination
  - setFileNameDestination
```
public void setFileNameDestination(java.lang.String fileNameDestination)
```
    Sets the filter for file names (FileTransfer destination). The wildcard characters "*" and "?" may be used. This field may also include more than one filter. Several filters must be separated by commas.
    
    Parameters:
    
    fileNameDestination - maximum 255 characters
  - getHostDestination
```
public java.lang.String getHostDestination()
```
    Returns the filter for Agent names.
    
    Returns:
    
    File Transfer destination
  - setHostDestination
```
public void setHostDestination(java.lang.String hostDestination)
```
    Sets the filter for Agent names (FileTransfer destination). The wildcard characters "*" and "?" may be used. This field may also include more than one filter. Several filters must be separated by commas.
    
    Parameters:
    
    hostDestination - maximum 200 characters
  - getLoginDestination
```
public java.lang.String getLoginDestination()
```
    Returns the filter for names of Login objects.
    
    Returns:
    
    FileTransfer destination
  - setLoginDestination
```
public void setLoginDestination(java.lang.String loginDestination)
```
    Sets the filter for names of Login objects (FileTransfer destination). The wildcard characters "*" and "?" may be used. This field may also include more than one filter. Several filters must be separated by commas.
    
    Parameters:
    
    loginDestination - maximum 200 characters
  - isRead
```
public boolean isRead()
```
    Description copied from interface: Rights
    
    Returns the access method: Read.
    
    Specified by:
    
    isRead in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setRead
```
public void setRead(boolean read)
```
    Description copied from interface: Rights
    
    Sets the access method: Read.
    
    Specified by:
    
    setRead in interface Rights
    
    Parameters:
    
    read - true to enable, false to disable this action
  - isWrite
```
public boolean isWrite()
```
    Description copied from interface: Rights
    
    Returns the access method: Write.
    
    Specified by:
    
    isWrite in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setWrite
```
public void setWrite(boolean write)
```
    Description copied from interface: Rights
    
    Sets the access method: Write.
    
    Specified by:
    
    setWrite in interface Rights
    
    Parameters:
    
    write - true to enable, false to disable this action
  - isExecute
```
public boolean isExecute()
```
    Description copied from interface: Rights
    
    Returns the access method: Execute.
    
    Specified by:
    
    isExecute in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setExecute
```
public void setExecute(boolean execute)
```
    Description copied from interface: Rights
    
    Sets the access method: Execute.
    
    Specified by:
    
    setExecute in interface Rights
    
    Parameters:
    
    execute - true to enable, false to disable this action
  - isDelete
```
public boolean isDelete()
```
    Description copied from interface: Rights
    
    Returns the access method: Delete.
    
    Specified by:
    
    isDelete in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setDelete
```
public void setDelete(boolean delete)
```
    Description copied from interface: Rights
    
    Sets the access method: Delete.
    
    Specified by:
    
    setDelete in interface Rights
    
    Parameters:
    
    delete - true to enable, false to disable this action
  - isCancel
```
public boolean isCancel()
```
    Description copied from interface: Rights
    
    Returns the access method: Cancel.
    
    Specified by:
    
    isCancel in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setCancel
```
public void setCancel(boolean cancel)
```
    Description copied from interface: Rights
    
    Sets the access method: Cancel.
    
    Specified by:
    
    setCancel in interface Rights
    
    Parameters:
    
    cancel - true to enable, false to disable this action
  - isStatistics
```
public boolean isStatistics()
```
    Description copied from interface: Rights
    
    Access to Statistics.
    
    Specified by:
    
    isStatistics in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setStatistics
```
public void setStatistics(boolean statistics)
```
    Description copied from interface: Rights
    
    Sets access to Statistics.
    
    Specified by:
    
    setStatistics in interface Rights
    
    Parameters:
    
    statistics - true to enable, false to disable this action
  - isReport
```
public boolean isReport()
```
    Description copied from interface: Rights
    
    Access to Reports.
    
    Specified by:
    
    isReport in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setReport
```
public void setReport(boolean report)
```
    Description copied from interface: Rights
    
    Sets access to Reports.
    
    Specified by:
    
    setReport in interface Rights
    
    Parameters:
    
    report - true to enable, false to disable this action
  - isModifyAtRuntime
```
public boolean isModifyAtRuntime()
```
    Description copied from interface: Rights
    
    Access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
    
    Specified by:
    
    isModifyAtRuntime in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setModifyAtRuntime
```
public void setModifyAtRuntime(boolean modifyAtRuntime)
```
    Description copied from interface: Rights
    
    Sets the access method: Modify at runtime This access method permits the setting of trace options on UC4 Automation Engines or Agents and the ending of RemoteTaskManager and Event objects.
    
    Specified by:
    
    setModifyAtRuntime in interface Rights
    
    Parameters:
    
    modifyAtRuntime - true to enable, false to disable this action
  - isDefineSLA
```
public boolean isDefineSLA()
```
    Description copied from interface: Rights
    
    Access method: Define SLA.
    
    Specified by:
    
    isDefineSLA in interface Rights
    
    Returns:
    
    true if enabled, false if disabled
  - setDefineSLA
```
public void setDefineSLA(boolean defineSLA)
```
    Description copied from interface: Rights
    
    Sets the access method: Define SLA.
    
    Specified by:
    
    setDefineSLA in interface Rights
    
    Parameters:
    
    defineSLA - true to enable, false to disable this action
  - isModified
```
protected boolean isModified()
```
  - setModified
```
protected void setModified(boolean b)
```

Class UserRight

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserRight

UserRight

Method Detail

save

getType

setType

getGrp

setGrp

getName

setName

getHost

setHost

getLogin

setLogin

getFileNameSource

setFileNameSource

getFileNameDestination

setFileNameDestination

getHostDestination

setHostDestination

getLoginDestination

setLoginDestination

isRead

setRead

isWrite

setWrite

isExecute

setExecute

isDelete

setDelete

isCancel

setCancel

isStatistics

setStatistics

isReport

setReport

isModifyAtRuntime

setModifyAtRuntime

isDefineSLA

setDefineSLA

isModified

setModified