java.lang.Object
- org.kuali.rice.kim.impl.jaxb.RoleMemberXmlDTO

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RoleMemberXmlDTO.OutsideOfRole, RoleMemberXmlDTO.WithinRole
```
public abstract class RoleMemberXmlDTO
extends Object
implements Serializable
```
Base class representing an unmarshalled <roleMember> element. Refer to the static inner classes for more information about the specific contexts.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`RoleMemberXmlDTO.OutsideOfRole`	This class represents a <roleMember> element that is not a descendant of a <role> element.
`static class`	`RoleMemberXmlDTO.WithinRole`	This class represents a <roleMember> element that is a descendant of a <role> element.

Constructor Summary

Constructors
Constructor	Description
`RoleMemberXmlDTO()`	Constructs an empty RoleMemberXmlDTO instance.
`RoleMemberXmlDTO(org.kuali.rice.kim.api.role.RoleMember roleMember, boolean populateMemberId)`	Constructs a RoleMemberXmlDTO instance that is populated with the info from the given role member.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`org.joda.time.DateTime`	`getActiveFromDate()`
`org.joda.time.DateTime`	`getActiveToDate()`
`String`	`getGroupId()`
`NameAndNamespacePair`	`getGroupName()`
`String`	`getMemberId()`	Retrieves the role member's ID, based on the member type and any populated member principal/group/role IDs.
`String`	`getMemberName()`	Retrieves the role member's name, based on the member type and any populated member principal/group/role names.
`String`	`getMemberNamespaceCode()`	Retrieves the role member's namespace code, based on the member type and any populated member principal/group/role names.
`MemberType`	`getMemberType()`	Retrieves the member type.
`String`	`getPrincipalId()`
`String`	`getPrincipalName()`
`Map<String,String>`	`getQualifications()`
`abstract String`	`getRoleId()`	Retrieves the ID of the role that this member belongs to.
`String`	`getRoleIdAsMember()`
`NameAndNamespacePair`	`getRoleNameAsMember()`
`void`	`setActiveFromDate(org.joda.time.DateTime activeFromDate)`
`void`	`setActiveToDate(org.joda.time.DateTime activeToDate)`
`void`	`setGroupId(String groupId)`
`void`	`setGroupName(NameAndNamespacePair groupName)`
`void`	`setPrincipalId(String principalId)`
`void`	`setPrincipalName(String principalName)`
`void`	`setQualifications(Map<String,String> qualifications)`
`void`	`setRoleIdAsMember(String roleIdAsMember)`
`void`	`setRoleNameAsMember(NameAndNamespacePair roleNameAsMember)`

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

- Constructor Detail
  - RoleMemberXmlDTO
```
public RoleMemberXmlDTO()
```
    Constructs an empty RoleMemberXmlDTO instance.
  - RoleMemberXmlDTO
```
public RoleMemberXmlDTO(org.kuali.rice.kim.api.role.RoleMember roleMember,
                        boolean populateMemberId)
```
    Constructs a RoleMemberXmlDTO instance that is populated with the info from the given role member.
    
    Parameters:
    
    roleMember - The role member that this DTO should populate its data from.
    
    populateMemberId - If true, the member principal/group/role ID will get populated; otherwise, only the member principal/group/role name and (if applicable) namespace will get populated.
    
    Throws:
    
    IllegalArgumentException - if roleMember is null, has an invalid member type, or refers to a nonexistent principal/group/role.
- Method Detail
  - getPrincipalId
```
public String getPrincipalId()
```
    Returns:
    
    the principalId
  - setPrincipalId
```
public void setPrincipalId(String principalId)
```
    Parameters:
    
    principalId - the principalId to set
  - getPrincipalName
```
public String getPrincipalName()
```
    Returns:
    
    the principalName
  - setPrincipalName
```
public void setPrincipalName(String principalName)
```
    Parameters:
    
    principalName - the principalName to set
  - getGroupId
```
public String getGroupId()
```
    Returns:
    
    the groupId
  - setGroupId
```
public void setGroupId(String groupId)
```
    Parameters:
    
    groupId - the groupId to set
  - getGroupName
```
public NameAndNamespacePair getGroupName()
```
    Returns:
    
    the groupName
  - setGroupName
```
public void setGroupName(NameAndNamespacePair groupName)
```
    Parameters:
    
    groupName - the groupName to set
  - getRoleIdAsMember
```
public String getRoleIdAsMember()
```
    Returns:
    
    the roleIdAsMember
  - setRoleIdAsMember
```
public void setRoleIdAsMember(String roleIdAsMember)
```
    Parameters:
    
    roleIdAsMember - the roleIdAsMember to set
  - getRoleNameAsMember
```
public NameAndNamespacePair getRoleNameAsMember()
```
    Returns:
    
    the roleNameAsMember
  - setRoleNameAsMember
```
public void setRoleNameAsMember(NameAndNamespacePair roleNameAsMember)
```
    Parameters:
    
    roleNameAsMember - the roleNameAsMember to set
  - getActiveFromDate
```
public org.joda.time.DateTime getActiveFromDate()
```
    Returns:
    
    the activeFromDate
  - setActiveFromDate
```
public void setActiveFromDate(org.joda.time.DateTime activeFromDate)
```
    Parameters:
    
    activeFromDate - the activeFromDate to set
  - getActiveToDate
```
public org.joda.time.DateTime getActiveToDate()
```
    Returns:
    
    the activeToDate
  - setActiveToDate
```
public void setActiveToDate(org.joda.time.DateTime activeToDate)
```
    Parameters:
    
    activeToDate - the activeToDate to set
  - getQualifications
```
public Map<String,String> getQualifications()
```
    Returns:
    
    the qualifications
  - setQualifications
```
public void setQualifications(Map<String,String> qualifications)
```
    Parameters:
    
    qualifications - the qualifications to set
  - getMemberType
```
public MemberType getMemberType()
```
    Retrieves the member type.
    If the member type is null at the time that this method is invoked, an attempt will be made to set its value based on any populated member principal/group/role ID/name information.
    
    Returns:
    
    the member type, or null if no membership identification information has been set on this member.
    
    Throws:
    
    IllegalStateException - if the role member is populated simultaneously with multiple member ID/name information
  - getMemberId
```
public String getMemberId()
```
    Retrieves the role member's ID, based on the member type and any populated member principal/group/role IDs.
    If the member type is null at the time that this method is invoked, an attempt will be made to set its value based on any populated member principal/group/role ID/name information.
    
    Returns:
    
    The member's ID, or null if the member type is null or the associated member ID information is null.
  - getMemberName
```
public String getMemberName()
```
    Retrieves the role member's name, based on the member type and any populated member principal/group/role names.
    If the member type is null at the time that this method is invoked, an attempt will be made to set its value based on any populated member principal/group/role ID/name information.
    
    Returns:
    
    The member's name, or null if the member type is null or the associated member name information is null.
  - getMemberNamespaceCode
```
public String getMemberNamespaceCode()
```
    Retrieves the role member's namespace code, based on the member type and any populated member principal/group/role names.
    If the member type is null at the time that this method is invoked, an attempt will be made to set its value based on any populated member principal/group/role ID/name information.
    
    Returns:
    
    The member's namespace code, or null if the member type is null, the associated member name information is null, or the role member is a principal.
  - getRoleId
```
public abstract String getRoleId()
```
    Retrieves the ID of the role that this member belongs to. Subclasses are responsible for implementing this method so that it does so.
    
    Returns:
    
    The role ID of the role that this member belongs to.

Class RoleMemberXmlDTO

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoleMemberXmlDTO

RoleMemberXmlDTO

Method Detail

getPrincipalId

setPrincipalId

getPrincipalName

setPrincipalName

getGroupId

setGroupId

getGroupName

setGroupName

getRoleIdAsMember

setRoleIdAsMember

getRoleNameAsMember

setRoleNameAsMember

getActiveFromDate

setActiveFromDate

getActiveToDate

setActiveToDate

getQualifications

setQualifications

getMemberType

getMemberId

getMemberName

getMemberNamespaceCode

getRoleId