CheckAuthorizations.Candidate

java.lang.Object
- com.uc4.communication.requests.CheckAuthorizations.Candidate

Enclosing class:

CheckAuthorizations
```
public static class CheckAuthorizations.Candidate
extends java.lang.Object
```
This class represents a candidate to test.

Constructor Summary

Constructors
Constructor and Description
`Candidate(GetObjectProperties properties, UserRight.Type objectType, char access)` Creates a new `Candidate` instance based on the result of the `GetObjectProperties` request.
`Candidate(IFolder folder, UserRight.Type objectType, char access)` Creates a new `Candidate` instance.
`Candidate(int runId, char access)` Creates a new `Candidate` instance considering executions.
`Candidate(UC4ObjectName obj, char access)` Creates a new `Candidate` instance.
`Candidate(UC4ObjectName obj, UserRight.Type objectType, char access)` Creates a new `Candidate` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)`
`char`	`getAccess()` Returns the access mode.
`IFolder`	`getFolder()` Returns the name of the Folder.
`UC4ObjectName`	`getName()` Returns the name of the Object.
`UserRight.Type`	`getObjectType()` Returns the object Type.
`boolean`	`getResult()` Returns the result of this check.
`int`	`getRunId()` Returns the run id of an execution.
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Candidate
```
public Candidate(UC4ObjectName obj,
                 UserRight.Type objectType,
                 char access)
```
    Creates a new Candidate instance.
    Parameters:
    
    obj - Name of the object
    
    objectType - Object type
    access -
    
    R...Read
    
    W...Write
    
    X...Execute
    
    D...Delete
    
    C...Cancel
    
    S...Statistics
    
    P...Reports
    
    M...Modify hat runtime
    
    L...Define SLA
  - Candidate
```
public Candidate(UC4ObjectName obj,
                 char access)
```
    Creates a new Candidate instance.
    Parameters:
    
    obj - Name of the object
    access -
    
    R...Read
    
    W...Write
    
    X...Execute
    
    D...Delete
    
    C...Cancel
    
    S...Statistics
    
    P...Reports
    
    M...Modify hat runtime
    
    L...Define SLA
  - Candidate
```
public Candidate(IFolder folder,
                 UserRight.Type objectType,
                 char access)
```
    Creates a new Candidate instance.
    Parameters:
    
    folder - Path to a folder
    
    objectType - Object type
    access -
    
    R...Read
    
    W...Write
    
    X...Execute
    
    D...Delete
    
    C...Cancel
    
    S...Statistics
    
    P...Reports
    
    M...Modify hat runtime
    
    L...Define SLA
  - Candidate
```
public Candidate(GetObjectProperties properties,
                 UserRight.Type objectType,
                 char access)
```
    Creates a new Candidate instance based on the result of the GetObjectProperties request.
    Parameters:
    
    properties - The result of an GetObjectProperties request
    
    objectType - Object type
    access -
    
    R...Read
    
    W...Write
    
    X...Execute
    
    D...Delete
    
    C...Cancel
    
    S...Statistics
    
    P...Reports
    
    M...Modify hat runtime
    
    L...Define SLA
  - Candidate
```
public Candidate(int runId,
                 char access)
```
    Creates a new Candidate instance considering executions.
    Parameters:
    
    runId - run id of an execution
    access -
    
    R...Read
    
    W...Write
    
    X...Execute
    
    D...Delete
    
    C...Cancel
    
    S...Statistics
    
    P...Reports
    
    M...Modify hat runtime
    
    L...Define SLA
- Method Detail
  - getResult
```
public boolean getResult()
```
    Returns the result of this check.
    
    Returns:
    
    true if the authorization check was successful, false if not.
  - getName
```
public UC4ObjectName getName()
```
    Returns the name of the Object.
    
    Returns:
    
    user
  - getFolder
```
public IFolder getFolder()
```
    Returns the name of the Folder.
    
    Returns:
    
    folder
  - getObjectType
```
public UserRight.Type getObjectType()
```
    Returns the object Type.
    
    Returns:
    
    Type
  - getAccess
```
public char getAccess()
```
    Returns the access mode.
    Returns:
    R...read
    
    W...write
    
    X...execute
    
    D...delete
    
    C...cancel
    
    S...Statistics
    
    P...Reports
    
    M...Modify hat runtime
  - getRunId
```
public int getRunId()
```
    Returns the run id of an execution.
    
    Returns:
    
    run id or -1 if not available.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class CheckAuthorizations.Candidate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Candidate

Candidate

Candidate

Candidate

Candidate

Method Detail

getResult

getName

getFolder

getObjectType

getAccess

getRunId

hashCode

equals

toString