oracle.iam.platform.authopss.vo

Class AdminRoleMembership

java.lang.Object

oracle.iam.platform.authopss.vo.AdminRoleMembership

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdminRoleMembershipWithoutHierarchy

public class AdminRoleMembership
extends java.lang.Object
implements java.io.Serializable

This class represents a role membership object and its attributes. Instances should be obtained using AdminRoleService. If more extensive relationship needs to be set on admin role (such as capability, SoC etc) then use AdminRoleVO instead.

Since:

OIM R2 (11.1.2.0.0)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminRoleMembership() Default constructor for eclipselink.
AdminRoleMembership(java.lang.String userId, AdminRole adminRole, java.lang.Long scopeId, boolean includeScopeHierarchy) Constructor for the class.

Method Summary

Modifier and Type	Method and Description
AdminRole	getAdminRole() Getter for the admin-role.
java.lang.Long	getAdminRoleId() Delegate method to conveniently return the admin role-id from AdminRole object
java.lang.String	getAdminRoleName() Delegate method to conveniently return the admin role-name from AdminRole object
java.lang.Long	getRoleMembershipId() The primary key representing the membership-id.
java.lang.String	getRootScopeId()
java.lang.String	getScopeId() Getter for the organization-id
java.lang.Long	getScopeIdAsLong()
java.lang.String	getUserId() Getter for the user-id.
boolean	isHierarchicalScope() Getter for the hierarchical flag that indicates whether user has admin rights on the the child organizations too.
void	setAdminRole(AdminRole adminRole) Setter for the admin role.
void	setHierarchicalScope(boolean scopeHierarchical) Setter for the hierarchical flag that indicates whether user has admin rights on the the child organizations too.
void	setRoleMembershipId(java.lang.Long roleMembershipId) Setter for the unique membership-id.
void	setRootScopeId(java.lang.String rootScopeId)
void	setRootScopeIdAsLong(java.lang.Long rootScopeIdAsLong)
void	setScopeId(java.lang.String scopeId) Setter for the scope(organization)-id
void	setUserId(java.lang.String userId) Setter for the user-id.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminRoleMembership

public AdminRoleMembership(java.lang.String userId,
                           AdminRole adminRole,
                           java.lang.Long scopeId,
                           boolean includeScopeHierarchy)

Constructor for the class.

Parameters:

userId - - the user-id of the user to whom the Admin-Role membership is being assigned.

adminRole - - The Admin Role object.

scopeId - - The organization on which the admin-role is being grnated to the user.

includeScopeHierarchy - - The hierarchy flag that represnts that user also has admin role on the child organizations.

AdminRoleMembership

public AdminRoleMembership()

Default constructor for eclipselink.

Method Detail

getRoleMembershipId

public java.lang.Long getRoleMembershipId()

The primary key representing the membership-id. Do not set this attribute while creating the membership.

Returns:

setRoleMembershipId

public void setRoleMembershipId(java.lang.Long roleMembershipId)

Setter for the unique membership-id.

Parameters:

roleMembershipId -

setUserId

public final void setUserId(java.lang.String userId)

Setter for the user-id.

Parameters:

userId -

getUserId

public final java.lang.String getUserId()

Getter for the user-id.

Returns:

getAdminRole

public AdminRole getAdminRole()

Getter for the admin-role.

Returns:

the adminRole

setAdminRole

public void setAdminRole(AdminRole adminRole)

Setter for the admin role.

Parameters:

adminRole - the adminRole to set

getAdminRoleId

public final java.lang.Long getAdminRoleId()

Delegate method to conveniently return the admin role-id from AdminRole object

Returns:

getAdminRoleName

public final java.lang.String getAdminRoleName()

Delegate method to conveniently return the admin role-name from AdminRole object

Returns:

setScopeId

public final void setScopeId(java.lang.String scopeId)

Setter for the scope(organization)-id

Parameters:

scopeId -

getScopeId

public final java.lang.String getScopeId()

Getter for the organization-id

Returns:

setHierarchicalScope

public final void setHierarchicalScope(boolean scopeHierarchical)

Setter for the hierarchical flag that indicates whether user has admin rights on the the child organizations too.

Parameters:

scopeHierarchical -

isHierarchicalScope

public final boolean isHierarchicalScope()

Getter for the hierarchical flag that indicates whether user has admin rights on the the child organizations too.

Returns:

getRootScopeId

public final java.lang.String getRootScopeId()

Returns:

the rootScopeId

setRootScopeId

public final void setRootScopeId(java.lang.String rootScopeId)

Parameters:

rootScopeId - the rootScopeId to set

getScopeIdAsLong

public java.lang.Long getScopeIdAsLong()

Returns:

the scopeIdAsLong

setRootScopeIdAsLong

public void setRootScopeIdAsLong(java.lang.Long rootScopeIdAsLong)

Parameters:

rootScopeIdAsLong - the rootScopeIdAsLong to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object