com.netegrity.llsdk6.imsapi.abstractinterface
Interface AssignableObject

All Superinterfaces:

AttributeCollection, ManagedObject, java.util.Map, ModifiableObject, NamedObject, java.io.Serializable

All Known Subinterfaces:

User

public interface AssignableObject
extends ManagedObject

Defines an object that can become a member of a role.

Since:

Identity Manager 8.1

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

void	assignRole(Role role) Deprecated. Deprecated in IdentityMinder 6.0. Use makeRoleMember().
java.util.Vector	getAccessRoles() Deprecated. Deprecated in IdentityMinder 6.0. Use getAccessRolesMember().
java.util.Vector	getAccessRolesAdministator() Retrieves the access roles for which the current object is an administrator.
java.util.Vector	getAccessRolesMember() Retrieves the access roles to which the current object is assigned.
java.util.Vector	getAccessRolesOwner() Retrieves the access roles for which the current object is an owner.
java.util.Vector	getAdminRoles() Deprecated. Deprecated in IdentityMinder 6.0. Use getAdminRolesMember().
java.util.Vector	getAdminRolesAdministrator() Retrieves the admin roles for which the current object is an administrator.
java.util.Vector	getAdminRolesMember() Retrieves the admin roles to which the current object is assigned.
java.util.Vector	getAdminRolesOwner() Retrieves the admin roles for which the current object is an owner.
java.util.Vector	getAdminTasks() Retrieves the admin tasks that the current object can perform.
java.util.Vector	getProvisioningRolesAdministrator() Retrieves the provisioning roles for which the current object is an administrator.
java.util.Vector	getProvisioningRolesMember() Retrieves the provisioning roles to which the current object is assigned.
java.util.Vector	getProvisioningRolesOwner() Retrieves the provisioning roles for which the current object is an owner.
java.util.Vector	getProvisioningRolesOwner(java.util.Vector rolesToSearch) Gets a list of Provisioning Roles this object is an owner of and contained in the list of rolesToSearch
boolean	hasRole(Role role) Deprecated. Deprecated in IdentityMinder 6.0. Use isRoleMember().
boolean	isRoleMember(Role role) Determines if the current object is a member of the specified role.
void	makeRoleMember(Role role) Assigns the current object to the specified role.
void	makeRoleMember(Role role, boolean addAccounts) Deprecated. Deprecated in IdentityMinder r12. Use makeRoleMember(Role role, boolean addAccounts, String operationID)
java.util.Vector	makeRoleMember(Role role, boolean addAccounts, java.lang.String operationID) Assigns the current object to the specified role, and optionally to create the associated accounts.(ProvisioningRole only).
void	removeFromRole(Role role) Deprecated. Deprecated in IdentityMinder 6,0. Use removeFromRoleMembership().
void	removeFromRoleMembership(Role role) Removes the current object from membership in the specified role.
void	removeFromRoleMembership(Role role, boolean removeAccounts) Deprecated. Deprecated in IdentityMinder r12. Use removeFromRoleMembership(Role role,boolean removeAccounts, String operationID)
java.util.Vector	removeFromRoleMembership(Role role, boolean removeAccounts, java.lang.String operationID) Removes the current object from membership in the specified role and optionally remove associated accounts (ProvisioningRole only)..

Methods inherited from interface com.netegrity.llsdk6.imsapi.managedobject.ManagedObject

directAddAttributeValue, directRemoveAttributeValue, equals, fixUniqueNames, getImsDirectory, getImsEnvironment, getObjectType, getOrg, getOrg, getProvider, hashCode, move, persisted

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.NamedObject

getFriendlyName, getUniqueName, toString

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.AttributeCollection

addAttributes, addValueToAttribute, containsAttribute, doesAttributeHaveMultipleValues, enumerateAttributes, getAttribute, getAttributeMultiValue, getAttributePermission, getAttributes, getExtendedAttribute, getLastCommittedAttribute, getLastCommittedAttributeMultiValue, getLastCommittedValue, getOriginalAttribute, getOriginalAttributeMultiValue, getOriginalValue, getValue, hasAttributeChanged, isAttributeUncommitted, isUncommitted, makeCurrentValueOriginal, removeAttributes, setAttribute, setAttributeMultiValue, setAttributes, setValue, updateAttributeSet

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

assignRole

void assignRole(Role role)
                throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use makeRoleMember().

Adds the current object to a role.

Parameters:

role - The role to which the current object is being assigned.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

makeRoleMember

void makeRoleMember(Role role)
                    throws SmApiException

Assigns the current object to the specified role.

Parameters:

role - The role to which the current object is being assigned.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

Since:

Identity Manager 8.1

makeRoleMember

java.util.Vector makeRoleMember(Role role,
                                boolean addAccounts,
                                java.lang.String operationID)
                                throws SmApiException

Assigns the current object to the specified role, and optionally to create the associated accounts.(ProvisioningRole only).

Parameters:

role - The role to which the current object is being assigned.

addAccounts - Creates associated accounts if true; does not create associated accounts if false.

operationID - Operation ID to be used for the JIAM commit operation. Ideally this should be derived from the IM eventID using ProvisioningDefinitionImpl.getIMOperationId() .

Returns:

JIAM Operation return message from admin server in case of a success.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

Since:

Identity Manager r12

makeRoleMember

void makeRoleMember(Role role,
                    boolean addAccounts)
                    throws SmApiException

Deprecated. Deprecated in IdentityMinder r12. Use makeRoleMember(Role role, boolean addAccounts, String operationID)

Assigns the current object to the specified role, and optionally to create the associated accounts.(ProvisioningRole only).

Parameters:

role - The role to which the current object is being assigned.

addAccounts - Creates associated accounts if true; does not create associated accounts if false.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

Since:

Identity Manager 8.1

removeFromRole

void removeFromRole(Role role)
                    throws SmApiException

Deprecated. Deprecated in IdentityMinder 6,0. Use removeFromRoleMembership().

Removes the current object from a role.

Parameters:

role - The role from which the current object is being removed.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

removeFromRoleMembership

void removeFromRoleMembership(Role role)
                              throws SmApiException

Removes the current object from membership in the specified role.

Parameters:

role - The role from which the current object is being removed.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

Since:

Identity Manager 8.1

removeFromRoleMembership

java.util.Vector removeFromRoleMembership(Role role,
                                          boolean removeAccounts,
                                          java.lang.String operationID)
                                          throws SmApiException

Removes the current object from membership in the specified role and optionally remove associated accounts (ProvisioningRole only)..

Parameters:

role - The role from which the current object is being removed.

removeAccounts - Removes associated accounts if set to true; does not remove associated accounts if set to false.

operationID - Operation ID to be used for the JIAM commit operation. Ideally this should be derived from the IM eventID using ProvisioningDefinitionImpl.getIMOperationId() .

Returns:

JIAM Operation return message from admin server in case of a success.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

Since:

Identity Manager r12

removeFromRoleMembership

void removeFromRoleMembership(Role role,
                              boolean removeAccounts)
                              throws SmApiException

Deprecated. Deprecated in IdentityMinder r12. Use removeFromRoleMembership(Role role,boolean removeAccounts, String operationID)

Removes the current object from membership in the specified role and optionally remove associated accounts (ProvisioningRole only)..

Parameters:

role - The role from which the current object is being removed.

removeAccounts - Removes associated accounts if set to true; does not remove associated accounts if set to false.

Throws:

com.netegrity.sdk.apiutil.SmApiException

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

Since:

Identity Manager 8.1

hasRole

boolean hasRole(Role role)
                throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use isRoleMember().

Determines if the current object is a member of the specified role.

Parameters:

role - The role to check.

Returns:

true if the object is a member of the role, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

isRoleMember

boolean isRoleMember(Role role)
                     throws SmApiException

Determines if the current object is a member of the specified role.

Parameters:

role - The role to check.

Returns:

true if the object is a member of the role, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getAdminRoles

java.util.Vector getAdminRoles()
                               throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use getAdminRolesMember().

Gets a list of Admin Roles this object is a member of.

Returns:

A Vector of roles.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getAccessRoles

java.util.Vector getAccessRoles()
                                throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use getAccessRolesMember().

Gets a list of Access Roles this object is a member of.

Returns:

A Vector of AccessRoles this occupant is a member of.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getAdminRolesMember

java.util.Vector getAdminRolesMember()
                                     throws SmApiException

Retrieves the admin roles to which the current object is assigned.

Returns:

The current object's admin roles.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getAccessRolesMember

java.util.Vector getAccessRolesMember()
                                      throws SmApiException

Retrieves the access roles to which the current object is assigned.

Returns:

The current object's access roles.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getProvisioningRolesMember

java.util.Vector getProvisioningRolesMember()
                                            throws SmApiException

Retrieves the provisioning roles to which the current object is assigned.

Returns:

The current object's provisioning roles.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

com.netegrity.llsdk6.imsapi.exception.UnsupportedDirectoryFeatureException - - If the associated directory does not support this role type

SmApiException

getAdminRolesAdministrator

java.util.Vector getAdminRolesAdministrator()
                                            throws SmApiException

Retrieves the admin roles for which the current object is an administrator.

Returns:

The admin roles for which the current object is an administrator.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getAccessRolesAdministator

java.util.Vector getAccessRolesAdministator()
                                            throws SmApiException

Retrieves the access roles for which the current object is an administrator.

Returns:

The access roles for which the current object is an administrator.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getProvisioningRolesAdministrator

java.util.Vector getProvisioningRolesAdministrator()
                                                   throws SmApiException

Retrieves the provisioning roles for which the current object is an administrator.

Returns:

The provisioning roles for which the current object is an administrator.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

com.netegrity.llsdk6.imsapi.exception.UnsupportedDirectoryFeatureException - - If the associated directory does not support this role type

SmApiException

getAdminRolesOwner

java.util.Vector getAdminRolesOwner()
                                    throws SmApiException

Retrieves the admin roles for which the current object is an owner.

A role owner can modify the role.

Returns:

The admin roles for which the current object is an owner.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getAccessRolesOwner

java.util.Vector getAccessRolesOwner()
                                     throws SmApiException

Retrieves the access roles for which the current object is an owner.

A role owner can modify the role.

Returns:

The access roles for which the current object is an owner.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException

getProvisioningRolesOwner

java.util.Vector getProvisioningRolesOwner()
                                           throws SmApiException

Retrieves the provisioning roles for which the current object is an owner.

A role owner can modify the role.

Returns:

The provisioning roles for which the current object is an owner.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

com.netegrity.llsdk6.imsapi.exception.UnsupportedDirectoryFeatureException - - If the associated directory does not support this role type

SmApiException

getProvisioningRolesOwner

java.util.Vector getProvisioningRolesOwner(java.util.Vector rolesToSearch)
                                           throws SmApiException

Gets a list of Provisioning Roles this object is an owner of and contained in the list of rolesToSearch

Parameters:

rolesToSearch - The list of roles that needs verification that this object is an owner of

Returns:

Vector An Vector of ProvisioningRoles this occupant is a member of

Throws:

com.netegrity.llsdk6.imsapi.exception.SmApiException

SmApiException

getAdminTasks

java.util.Vector getAdminTasks()
                               throws SmApiException

Retrieves the admin tasks that the current object can perform.

Returns:

The admin tasks that the object can perform.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this AssignableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this AssignableObject represents an object which can be deleted, that has already been deleted

SmApiException