com.ibm.itim.dataservices.model.domain
Class AccessInfo

java.lang.Object
  extended by 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 Manager 5.1
See Also:
Serialized Form

Field Summary
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_APPROVAL_PROCESS_ID, ACCESS_ATTR_DESC, ACCESS_ATTR_NAME, ACCESS_ATTR_NOTIFY_DEPROVISION, ACCESS_ATTR_NOTIFY_PROVISION, ACCESS_ATTR_OPTION, ACCESS_ATTR_OWNER, ACCESS_ATTR_TYPE
 
Constructor Summary
AccessInfo(java.lang.String name, java.lang.String type)
          Constructs the object with access's name and type.
 
Method Summary
 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.
 AttributeValues getAttributes()
          Returns A list of attribute value pair that holds the access information.
 ProvisioningConfiguration getProvisioningConfiguration()
          Returns the provisioning configuration of the access.
 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 setProvisioningConfiguration(ProvisioningConfiguration theProvisioningConfiguration)
          Sets the provisioning configuration.
 
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.


IBM Security Identity Manager 6.0.0
© Copyright International Business Machines Corporation 2007, 2012. All rights reserved. US Government Users Restricited Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.