AccessInfo

java.lang.Object
- com.ibm.itim.dataservices.model.domain.AccessInfo

All Implemented Interfaces:

Access, java.io.Serializable
```
public class AccessInfo
extends java.lang.Object
implements java.io.Serializable, Access
```
This is a value object that contains information about the Access. Access is a generic interface to represent an access and access provisioning configuration. All the attributes of erAccessItem are MAY attributes and therefore any client using this API should know that the API will accept null and empty values without throwing any exceptions.

Since:

Tivoli Identity Governance 5.1

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESS_ENABLED` Access option: Access is enabled for the user request.
`static int`	`COMMON_ACCESS` Access option: Access is enabled for the user request and it is commonly requested.
`static int`	`NO_ACCESS` Access option: Access is disabled for the user request.

Fields inherited from interface com.ibm.itim.dataservices.model.domain.access.Access
ACCESS_ATTR_ADDITIONAL_INFO, ACCESS_ATTR_APPROVAL_PROCESS_ID, ACCESS_ATTR_BADGE, ACCESS_ATTR_CATEGORY, ACCESS_ATTR_DESC, ACCESS_ATTR_ICON, ACCESS_ATTR_NAME, ACCESS_ATTR_NOTIFY_DEPROVISION, ACCESS_ATTR_NOTIFY_PROVISION, ACCESS_ATTR_OPTION, ACCESS_ATTR_OWNER, ACCESS_ATTR_TAG, ACCESS_ATTR_TYPE

Constructor Summary

Constructors
Constructor and Description

AccessInfo(java.lang.String name, java.lang.String type)
Constructs the object with access's name and type.

Constructors
Constructor and Description
`AccessInfo(java.lang.String name, java.lang.String type)` Constructs the object with access's name and type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccessDescription()` Returns the access description.
`java.lang.String`	`getAccessId()` Returns the unique id for the access.
`java.lang.String`	`getAccessName()` Returns the access name.
`int`	`getAccessOption()` Returns the access option.
`DistinguishedName`	`getAccessOwner()` Returns the DisginuishedName of the access administration owner.
`java.lang.String`	`getAccessType()` Returns the access type.
`java.lang.String`	`getAdditionalInfo()` Return Special kind of information in case regular description is not sufficient enough.
`AttributeValues`	`getAttributes()` Returns A list of attribute value pair that holds the access information.
`java.util.Set<Badge>`	`getBadges()` Return Set of badges - labels with display format information (style)
`java.lang.String`	`getIconURI()` Return URI pointing to access icon
`ProvisioningConfiguration`	`getProvisioningConfiguration()` Returns the provisioning configuration of the access.
`java.util.Set<java.lang.String>`	`getTags()` Return keywords for describing access for search purposes
`boolean`	`isAccessEnabled()` Returns true if access is enabled for user request, false otherwise.
`boolean`	`isCommonAccess()` Returns true if access is enabled for user request and it is commonly requested, false otherwise.
`void`	`setAccessDescription(java.lang.String theAccessDescription)` Sets the access description.
`void`	`setAccessName(java.lang.String theAccessName)` Sets the access name.
`void`	`setAccessOption(int theAccessOption)` Sets the access option.
`void`	`setAccessOwner(DistinguishedName theAccessOwner)` Sets the owner of the access.
`void`	`setAccessType(java.lang.String theAccessType)` Sets the access type.
`void`	`setAdditionalInfo(java.lang.String additionalInfo)`
`void`	`setBadges(java.util.Set<Badge> badges)`
`void`	`setIconURI(java.lang.String iconURI)`
`void`	`setProvisioningConfiguration(ProvisioningConfiguration theProvisioningConfiguration)` Sets the provisioning configuration.
`void`	`setTags(java.util.Set<java.lang.String> tags)`

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

- Field Detail
  - NO_ACCESS
```
public static final int NO_ACCESS
```
    Access option: Access is disabled for the user request.
    
    See Also:
    
    Constant Field Values
  - ACCESS_ENABLED
```
public static final int ACCESS_ENABLED
```
    Access option: Access is enabled for the user request.
    
    See Also:
    
    Constant Field Values
  - COMMON_ACCESS
```
public static final int COMMON_ACCESS
```
    Access option: Access is enabled for the user request and it is commonly requested.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AccessInfo
```
public AccessInfo(java.lang.String name,
                  java.lang.String type)
```
    Constructs the object with access's name and type.
    Parameters:
    
    name - the name of the access.
    type - the type of the access. The type might be one of these default access types:
    
    Application
    
    SharedFolder
    
    MailGroup
    
    AccessRole
- Method Detail
  - getAccessDescription
```
public java.lang.String getAccessDescription()
```
    Description copied from interface: Access
    
    Returns the access description.
    
    Specified by:
    
    getAccessDescription in interface Access
    
    Returns:
    
    String that represents the access description
  - setAccessDescription
```
public void setAccessDescription(java.lang.String theAccessDescription)
```
    Sets the access description.
    
    Parameters:
    
    theAccessDescription - the description of the access.
  - getAccessId
```
public java.lang.String getAccessId()
```
    Description copied from interface: Access
    
    Returns the unique id for the access.
    
    Specified by:
    
    getAccessId in interface Access
    
    Returns:
    
    String format of the id
  - getAccessName
```
public java.lang.String getAccessName()
```
    Description copied from interface: Access
    
    Returns the access name.
    
    Specified by:
    
    getAccessName in interface Access
    
    Returns:
    
    String that represents the name
  - setAccessName
```
public void setAccessName(java.lang.String theAccessName)
```
    Sets the access name.
    
    Parameters:
    
    theAccessName - the name of the access.
  - getAccessOwner
```
public DistinguishedName getAccessOwner()
```
    Description copied from interface: Access
    
    Returns the DisginuishedName of the access administration owner.
    
    Specified by:
    
    getAccessOwner in interface Access
    
    Returns:
    
    DisginuishedName of the owner
  - setAccessOwner
```
public void setAccessOwner(DistinguishedName theAccessOwner)
```
    Sets the owner of the access.
    
    Parameters:
    
    theAccessOwner - The distinguished name of the owner.
  - getAccessType
```
public java.lang.String getAccessType()
```
    Description copied from interface: Access
    
    Returns the access type.
    
    Specified by:
    
    getAccessType in interface Access
    
    Returns:
    
    String that represents the type
  - setAccessType
```
public void setAccessType(java.lang.String theAccessType)
```
    Sets the access type.
    
    Parameters:
    
    theAccessType - The type of the access.
  - getProvisioningConfiguration
```
public ProvisioningConfiguration getProvisioningConfiguration()
```
    Description copied from interface: Access
    
    Returns the provisioning configuration of the access.
    
    Specified by:
    
    getProvisioningConfiguration in interface Access
    
    Returns:
    
    ProvisioningConfiguration
    
    See Also:
    
    ProvisioningConfiguration
  - setProvisioningConfiguration
```
public void setProvisioningConfiguration(ProvisioningConfiguration theProvisioningConfiguration)
```
    Sets the provisioning configuration.
    
    Parameters:
    
    theProvisioningConfiguration - The provisioning configuration to be set.
  - isAccessEnabled
```
public boolean isAccessEnabled()
```
    Description copied from interface: Access
    
    Returns true if access is enabled for user request, false otherwise.
    
    Specified by:
    
    isAccessEnabled in interface Access
  - isCommonAccess
```
public boolean isCommonAccess()
```
    Description copied from interface: Access
    
    Returns true if access is enabled for user request and it is commonly requested, false otherwise.
    
    Specified by:
    
    isCommonAccess in interface Access
  - setAccessOption
```
public void setAccessOption(int theAccessOption)
```
    Sets the access option.
    
    Parameters:
    
    theAccessOption - A valid value is NO_ACCESS, ACCESS_ENABLED, or COMMON_ACCESS.
  - getAccessOption
```
public int getAccessOption()
```
    Returns the access option.
  - getAttributes
```
public AttributeValues getAttributes()
```
    Returns A list of attribute value pair that holds the access information.
    
    Returns:
    
    list of AttributeValue holding the access information.
  - getTags
```
public java.util.Set<java.lang.String> getTags()
```
    Description copied from interface: Access
    
    Return keywords for describing access for search purposes
    
    Specified by:
    
    getTags in interface Access
    
    Returns:
    
    Set of keywords
  - getBadges
```
public java.util.Set<Badge> getBadges()
```
    Description copied from interface: Access
    
    Return Set of badges - labels with display format information (style)
    
    Specified by:
    
    getBadges in interface Access
    
    Returns:
    
    Set of Badge objects
  - getIconURI
```
public java.lang.String getIconURI()
```
    Description copied from interface: Access
    
    Return URI pointing to access icon
    
    Specified by:
    
    getIconURI in interface Access
    
    Returns:
    
    icon URI value
  - getAdditionalInfo
```
public java.lang.String getAdditionalInfo()
```
    Description copied from interface: Access
    
    Return Special kind of information in case regular description is not sufficient enough.
    
    Specified by:
    
    getAdditionalInfo in interface Access
    
    Returns:
    
    additional information
  - setAdditionalInfo
```
public void setAdditionalInfo(java.lang.String additionalInfo)
```
  - setBadges
```
public void setBadges(java.util.Set<Badge> badges)
```
  - setTags
```
public void setTags(java.util.Set<java.lang.String> tags)
```
  - setIconURI
```
public void setIconURI(java.lang.String iconURI)
```

Fields inherited from interface com.ibm.itim.dataservices.model.domain.access.Access

Methods inherited from class java.lang.Object

NO_ACCESS

ACCESS_ENABLED

COMMON_ACCESS

AccessInfo

getAccessDescription

setAccessDescription

getAccessId

getAccessName

setAccessName

getAccessOwner

setAccessOwner

getAccessType

setAccessType

getProvisioningConfiguration

setProvisioningConfiguration

isAccessEnabled

isCommonAccess

setAccessOption

getAccessOption

getAttributes

getTags

getBadges

getIconURI

getAdditionalInfo

setAdditionalInfo

setBadges

setTags

setIconURI