blackboard.dataintegration.ims.data
Class IMSPerson

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

public class IMSPerson
extends java.lang.Object

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

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

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 IMSPerson.Gender
          Possible values for person gender.
static class IMSPerson.InstitutionRole
          Possible values for person institution roles.
static class IMSPerson.SystemRole
          Possible values for person system roles.
 
Constructor Summary
IMSPerson()
           
 
Method Summary
 Adr getAdr()
          Get this Person's address.
 java.util.Calendar getBday()
          Get this Person's birthday.
 java.lang.String getComments()
          Get comments about the full Person structure.
 java.lang.String getDatasource()
          Get the identifier of the source system of this Person.
 java.util.List<java.lang.String> getDisabilities()
          Get the list of any disabilities this Person may have.
 java.lang.String getEmail()
          Get this Person's email address.
 java.lang.String getExtension()
          Get an XML string containing the custom extension data for this Person.
 IMSPerson.Gender getGender()
          Get this Person's gender.
 Name getName()
          Get this Person's name information.
 java.util.List<java.lang.String> getParentNodeList()
           
 org.apache.axiom.om.OMElement getPersonOMElement()
          Get the OMElement that represents the XML used to create the instance of this IMSPerson.
 java.lang.String getPhotoExtref()
          Get a URL to photo of this Person.
 IMSPerson.InstitutionRole getPrimaryInstitutionRole()
          Get this Person's primary Institution Role.
 Recstatus getRecstatus()
          Get the type of operation to be performed on this Person.
 java.util.List<IMSPerson.InstitutionRole> getSecondaryInstitutionRoles()
          Get the list of this Person's secondary Institution Roles.
 SourcedId getSourcedIdByType(SourcedId.SourcedIdType type)
          Get the first sourcedId in this Person's list of sourcedIds with the matching type.
 SourcedId getSourcedIdCurrent()
          Get this Person's current SourcedId.
 java.util.List<SourcedId> getSourcedIdList()
          Get all of this Person's SourcedIds.
 SourcedId getSourcedIdNew()
          Get this Person's replacement SourcedId.
 IMSPerson.SystemRole getSystemRole()
          Get this Person's System Role.
 java.util.List<Tel> getTelList()
          Get this Person's telephone number information.
 java.lang.String getUrl()
          Get this Person's web address.
 UserId getUserIdByType(java.lang.String type)
          Get the first userId in this Person's list of user ids with the matching type.
 java.util.List<UserId> getUserIdList()
          Get the list of this Person's user ids.
 void setAdr(Adr adr)
          Set this Person's address.
 void setBday(java.util.Calendar bday)
          Set this Person's birthday.
 void setComments(java.lang.String comments)
          Set comments about the full Person structure.
 void setDatasource(java.lang.String datasource)
          Set the identifier of the source system of this Person.
 void setDisabilities(java.util.List<java.lang.String> disabilities)
          Set the list of any disabilities this Person may have.
 void setEmail(java.lang.String email)
          Set this Person's email address.
 void setExtension(java.lang.String extension)
          Set the custom extension data for this Person.
 void setGender(IMSPerson.Gender gender)
          Set this Person's gender.
 void setName(Name name)
          Set this Person's name information.
 void setParentNodeList(java.util.List<java.lang.String> parentNodeList)
           
 void setPersonOMElement(org.apache.axiom.om.OMElement personOMElement)
           
 void setPhotoExtref(java.lang.String photoExtref)
          Set a URL to photo of this Person.
 void setPrimaryInstitutionRole(IMSPerson.InstitutionRole primaryInstitutionRole)
          Set this Person's primary Institution Role.
 void setRecstatus(Recstatus recstatus)
          Set the type of operation to be performed on this Person.
 void setSecondaryInstitutionRoles(java.util.List<IMSPerson.InstitutionRole> secondaryInstitutionRoles)
          Set the list of this Person's secondary Institution Roles.
 void setSourcedIdList(java.util.List<SourcedId> sourcedIdList)
          Set all of this Person's SourcedIds.
 void setSystemRole(IMSPerson.SystemRole systemRole)
          Set this Person's System Role.
 void setTelList(java.util.List<Tel> telList)
          Set this Person's telephone number information.
 void setUrl(java.lang.String url)
          Set this Person's web address.
 void setUserIdList(java.util.List<UserId> userIdList)
          Set the list of this Person's user ids.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IMSPerson

public IMSPerson()
Method Detail

getAdr

public Adr getAdr()
Get this Person's address.

Returns:
This Person's address

getBday

public java.util.Calendar getBday()
Get this Person's birthday.

Returns:
This Person's birthday.

getComments

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

Returns:
The comments about the full Person structure

getDatasource

public java.lang.String getDatasource()
Get the identifier of the source system of this Person.

Returns:
The data source.

getDisabilities

public java.util.List<java.lang.String> getDisabilities()
Get the list of any disabilities this Person may have.

Returns:
The list of any disabilities this Person may have.

getEmail

public java.lang.String getEmail()
Get this Person's email address.

Returns:
This Person's email address.

getExtension

public java.lang.String getExtension()
Get an XML string containing the custom extension data for this Person.

In your script, you can use:

 helper.getXPathString( data.extension, '/some/xpath/query' );
 
To do an XPath query to easily get data out of this string.

Returns:
The custom extension data.

getGender

public IMSPerson.Gender getGender()
Get this Person's gender.

Returns:
This Person's gender.

getName

public Name getName()
Get this Person's name information.

Returns:
This Person's name information.

getPersonOMElement

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

Returns:
an OMElement of this IMSPerson instance.

getPhotoExtref

public java.lang.String getPhotoExtref()
Get a URL to photo of this Person.

Returns:
A URL to a photo of this Person.

getPrimaryInstitutionRole

public IMSPerson.InstitutionRole getPrimaryInstitutionRole()
Get this Person's primary Institution Role.

Returns:
This Person's primary Institution Role.

getRecstatus

public Recstatus getRecstatus()
Get the type of operation to be performed on this Person.

Returns:
The type of operation to be performed on this Person.

getSecondaryInstitutionRoles

public java.util.List<IMSPerson.InstitutionRole> getSecondaryInstitutionRoles()
Get the list of this Person's secondary Institution Roles.

Returns:
This Person's secondary Institution Roles.

getSourcedIdByType

public SourcedId getSourcedIdByType(SourcedId.SourcedIdType type)
Get the first sourcedId in this Person's list of sourcedIds with the matching type.

Parameters:
type - the SourcedIdType to look for in this Person's list of sourcedIds.
Returns:
The matching SourcedId or null if there is no match.

getSourcedIdCurrent

public SourcedId getSourcedIdCurrent()
Get this Person's current SourcedId.

Returns:
This Person's current SourcedId.

getSourcedIdList

public java.util.List<SourcedId> getSourcedIdList()
Get all of this Person's SourcedIds.

Returns:
A list of this Person's SourcedIds.

getSourcedIdNew

public SourcedId getSourcedIdNew()
Get this Person's replacement SourcedId.

Returns:
This Person's replacement SourcedId.

getSystemRole

public IMSPerson.SystemRole getSystemRole()
Get this Person's System Role.

Returns:
This Person's System Role.

getTelList

public java.util.List<Tel> getTelList()
Get this Person's telephone number information.

Returns:
The Person's telephone number information.

getUrl

public java.lang.String getUrl()
Get this Person's web address.

Returns:
This Person's web address.

getUserIdByType

public UserId getUserIdByType(java.lang.String type)
Get the first userId in this Person's list of user ids with the matching type.

Parameters:
type - The type to look for in the list.
Returns:
The matching UserId, null if ther is no match.

getUserIdList

public java.util.List<UserId> getUserIdList()
Get the list of this Person's user ids.

Returns:
The list of this Person's user ids.

setAdr

public void setAdr(Adr adr)
Set this Person's address.

Parameters:
adr - This Person's address

setBday

public void setBday(java.util.Calendar bday)
Set this Person's birthday.

Parameters:
bday - This Person's birthday.

setComments

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

Parameters:
comments - The comments about the full Person structure

setDatasource

public void setDatasource(java.lang.String datasource)
Set the identifier of the source system of this Person.

Parameters:
datasource - The data source.

setDisabilities

public void setDisabilities(java.util.List<java.lang.String> disabilities)
Set the list of any disabilities this Person may have.

Parameters:
disabilities - The list of any disabilities this Person may have.

setEmail

public void setEmail(java.lang.String email)
Set this Person's email address.

Parameters:
email - This Person's email address.

setExtension

public void setExtension(java.lang.String extension)
Set the custom extension data for this Person.

Parameters:
extension - The custom extension data.

setGender

public void setGender(IMSPerson.Gender gender)
Set this Person's gender.

Parameters:
gender - This Person's gender.

setName

public void setName(Name name)
Set this Person's name information.

Parameters:
name - This Person's name information.

setPersonOMElement

public void setPersonOMElement(org.apache.axiom.om.OMElement personOMElement)

setPhotoExtref

public void setPhotoExtref(java.lang.String photoExtref)
Set a URL to photo of this Person.

Parameters:
photoExtref - A URL to a photo of this Person.

setPrimaryInstitutionRole

public void setPrimaryInstitutionRole(IMSPerson.InstitutionRole primaryInstitutionRole)
Set this Person's primary Institution Role.

Parameters:
primaryInstitutionRole - This Person's primary Institution Role.

setRecstatus

public void setRecstatus(Recstatus recstatus)
Set the type of operation to be performed on this Person.

Parameters:
recstatus - The type of operation to be performed on this Person.

setSecondaryInstitutionRoles

public void setSecondaryInstitutionRoles(java.util.List<IMSPerson.InstitutionRole> secondaryInstitutionRoles)
Set the list of this Person's secondary Institution Roles.

Parameters:
secondaryInstitutionRoles - This Person's secondary Institution Roles.

setSourcedIdList

public void setSourcedIdList(java.util.List<SourcedId> sourcedIdList)
Set all of this Person's SourcedIds.

Parameters:
sourcedIdList - A list of this Person's SourcedIds.

setSystemRole

public void setSystemRole(IMSPerson.SystemRole systemRole)
Set this Person's System Role.

Parameters:
systemRole - This Person's System Role.

setTelList

public void setTelList(java.util.List<Tel> telList)
Set this Person's telephone number information.

Parameters:
telList - The Person's telephone number information.

setUrl

public void setUrl(java.lang.String url)
Set this Person's web address.

Parameters:
url - This Person's web address.

setUserIdList

public void setUserIdList(java.util.List<UserId> userIdList)
Set the list of this Person's user ids.

Parameters:
userIdList - The list of this Person's user ids.

setParentNodeList

public void setParentNodeList(java.util.List<java.lang.String> parentNodeList)
Parameters:
parentNodeList - the parentNodeList to set

getParentNodeList

public java.util.List<java.lang.String> getParentNodeList()
Returns:
the parentNodeList


Copyright © 2012 Blackboard, Inc. All Rights Reserved.