Class AdminRoleMembership

java.lang.Object
oracle.iam.platform.authopss.vo.AdminRoleMembership
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AdminRoleMembershipWithoutHierarchy

public class AdminRoleMembership extends Object implements 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:
  • Constructor Details

    • AdminRoleMembership

      public AdminRoleMembership(String userId, AdminRole adminRole, 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 Details

    • getRoleMembershipId

      public Long getRoleMembershipId()
      The primary key representing the membership-id. Do not set this attribute while creating the membership.
      Returns:
    • setRoleMembershipId

      public void setRoleMembershipId(Long roleMembershipId)
      Setter for the unique membership-id.
      Parameters:
      roleMembershipId -
    • setUserId

      public final void setUserId(String userId)
      Setter for the user-id.
      Parameters:
      userId -
    • getUserId

      public final 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 Long getAdminRoleId()
      Delegate method to conveniently return the admin role-id from AdminRole object
      Returns:
    • getAdminRoleName

      public final String getAdminRoleName()
      Delegate method to conveniently return the admin role-name from AdminRole object
      Returns:
    • setScopeId

      public final void setScopeId(String scopeId)
      Setter for the scope(organization)-id
      Parameters:
      scopeId -
    • getScopeId

      public final 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 String getRootScopeId()
      Returns:
      the rootScopeId
    • setRootScopeId

      public final void setRootScopeId(String rootScopeId)
      Parameters:
      rootScopeId - the rootScopeId to set
    • getScopeIdAsLong

      public Long getScopeIdAsLong()
      Returns:
      the scopeIdAsLong
    • setRootScopeIdAsLong

      public void setRootScopeIdAsLong(Long rootScopeIdAsLong)
      Parameters:
      rootScopeIdAsLong - the rootScopeIdAsLong to set
    • toString

      public String toString()
      Overrides:
      toString in class Object