blackboard.dataintegration.ims.data
Class IMSMember

java.lang.Object
  extended by blackboard.dataintegration.ims.data.IMSMember

public class IMSMember
extends java.lang.Object

Contains information about a Membership record in IMS Enterprise 1.1 XML.

Unlike the IMSGroup and IMSPerson records that map directly to the top level person and group XML entries, the setup of IMSMember is a bit more complicated. The IMS enterprise format has a top level membership XML element that contains the SourcedId of the corresponding Group, then multiple records for individual user Members associated to that group.

Because our data mapping layer maps individual member records for field mapping, we've slightly inverted the data model. So the object passed into our mapping doesn't correspond to the top level membership XML element, but instead we have separate instances for each member record within that XML. And to provide all the data, each IMSMember object will also contain info corresponding to the shared info on the containing membership record.

This is the root object that you will be provided with as the data variable in mapping scripts for IMS Members.

You can access the data either using bean properties, or the getters themselves. E.g.

 var x = data.comments;
 // is the same as
 var x = data.getComments();
 

NOTE: This class is included in the Public API for use by Data Integration custom field mapping scripts. It should not be used by any Building Blocks.

Since:
Bb 9.1 SP6

Nested Class Summary
static class IMSMember.IdType
          Indicates if the Member is a Person or another Group.
 
Constructor Summary
IMSMember()
           
 
Method Summary
 java.lang.String getComments()
          Get comments about the full Member structure.
 IMSMember.IdType getIdtype()
          Get the type of member - Person or Group.
 org.apache.axiom.om.OMElement getMemberOMElement()
          Get the OMElement that represents the XML used to create the instance of this IMSMember.
 Membership getMembership()
          Get information about the top-level Membership.
 java.util.List<Role> getRoleList()
          Get the full list of Roles that the member has.
 java.util.List<Role> getRolesToAddOrUpdate()
          Get just the list of roles that are to be added or updated.
 java.util.List<Role> getRolesToDelete()
          Get just the list of roles that are to be removed.
 SourcedId getSourcedid()
          Get the sourcedId of the Member.
 void setComments(java.lang.String comments)
          Set comments about the full Member structure.
 void setIdtype(IMSMember.IdType idtype)
          Set the type of member - Person or Group.
 void setMemberOMElement(org.apache.axiom.om.OMElement memberOMElement)
           
 void setMembership(Membership membership)
          Set the top-level Membership.
 void setRoleList(java.util.List<Role> roleList)
          Set the full list of Roles that the member has.
 void setSourcedid(SourcedId sourcedid)
          Set the sourcedId of the Member.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IMSMember

public IMSMember()
Method Detail

getComments

public java.lang.String getComments()
Get comments about the full Member structure.

Returns:
The comments about the full Member structure.

getIdtype

public IMSMember.IdType getIdtype()
Get the type of member - Person or Group.

Returns:
The type of member.

getMemberOMElement

public org.apache.axiom.om.OMElement getMemberOMElement()
Get the OMElement that represents the XML used to create the instance of this IMSMember.

Returns:
an OMElement of this IMSMember instance.

getMembership

public Membership getMembership()
Get information about the top-level Membership.

This contains information about the group that the member is associated with.

Returns:
The information about the top-level Membership.

getRoleList

public java.util.List<Role> getRoleList()
Get the full list of Roles that the member has.

Returns:
The list of Roles that the member has.

getRolesToAddOrUpdate

public java.util.List<Role> getRolesToAddOrUpdate()
Get just the list of roles that are to be added or updated.

Returns:
The list of roles that are to be added or updated.

getRolesToDelete

public java.util.List<Role> getRolesToDelete()
Get just the list of roles that are to be removed.

Returns:
The list of roles that are to be removed.

getSourcedid

public SourcedId getSourcedid()
Get the sourcedId of the Member.

This is the Person/Group sourcedId..

Returns:
The sourcedId of the Member.

setComments

public void setComments(java.lang.String comments)
Set comments about the full Member structure.

Parameters:
comments - The comments about the full Member structure.

setIdtype

public void setIdtype(IMSMember.IdType idtype)
Set the type of member - Person or Group.

Parameters:
idtype - The type of member.

setMemberOMElement

public void setMemberOMElement(org.apache.axiom.om.OMElement memberOMElement)

setMembership

public void setMembership(Membership membership)
Set the top-level Membership.

Parameters:
membership - The top-level Membership.

setRoleList

public void setRoleList(java.util.List<Role> roleList)
Set the full list of Roles that the member has.

Parameters:
roleList - The list of Roles that the member has.

setSourcedid

public void setSourcedid(SourcedId sourcedid)
Set the sourcedId of the Member.

This is the Person/Group sourcedId..

Parameters:
sourcedid - The sourcedId of the Member.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.