blackboard.dataintegration.lis.data.person
Class Person

java.lang.Object
  extended by blackboard.dataintegration.lis.data.person.Person

public class Person
extends java.lang.Object

Contains information about a LIS Person.

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

Constructor Summary
Person()
           
 
Method Summary
 void addAddress(java.lang.String type, Address address)
          Add an address to this Person.
 void addAgent(java.lang.String type, Agent agent)
          Add an agent to this Person.
 void addContactInfo(java.lang.String type, ContactInfo contactInfo)
          Add contact information to this Person.
 void addDemographics(java.lang.String type, Demographics demographics)
          Add demographics information to this Person.
 void addExtension(java.lang.String name, ExtensionField f)
          Add a custom extension field to this Person.
 void addFormattedName(java.lang.String type, FormattedName formattedName)
          Add a formatted name to this Person.
 void addName(java.lang.String type, Name name)
          Add a name to this Person.
 void addRoles(Roles roles)
          Add role information to this Person.
 java.util.Map<java.lang.String,Address> getAddresses()
          Get information about the Person's addresses.
 java.util.Map<java.lang.String,Agent> getAgents()
          Get the agents who can act on behalf of this Person.
 java.util.Map<java.lang.String,ContactInfo> getContactInfo()
          Get the Person's contact information.
 java.util.Map<java.lang.String,Demographics> getDemographics()
          Get demographic information about the Person.
 java.util.Map<java.lang.String,ExtensionField> getExtensions()
          Get any custom extensions to the Person data.
 java.util.Map<java.lang.String,FormattedName> getFormattedNames()
          Get formatted versions of the Person's name.
 java.util.Map<java.lang.String,Name> getNames()
          Get detailed versions of the Person's name.
 java.util.List<Roles> getRoles()
          Get the user's role information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Person

public Person()
Method Detail

getFormattedNames

public java.util.Map<java.lang.String,FormattedName> getFormattedNames()
Get formatted versions of the Person's name.

The returned Map is of FormattedName type to FormattedName.

The list of types can be found in the LIS Person Management Service Information Model, Appendix B1.1

http://imsglobal.org/lis/lisv2p0pd/PMSinfoModelv2p0pd.html

Returns:
The formatted versions of the Person's name.

getNames

public java.util.Map<java.lang.String,Name> getNames()
Get detailed versions of the Person's name.

The returned Map is of Name type to Name.

The list of types can be found in the LIS Person Management Service Information Model, Appendix B1.2

http://imsglobal.org/lis/lisv2p0pd/PMSinfoModelv2p0pd.html

Returns:
The detailed versions of the Person's name.

getAddresses

public java.util.Map<java.lang.String,Address> getAddresses()
Get information about the Person's addresses.

The returned Map is of Address type to Address.

The list of types can be found in the LIS Person Management Service Information Model, Appendix B1.4

http://imsglobal.org/lis/lisv2p0pd/PMSinfoModelv2p0pd.html

Returns:
The information about the Person's addresses.

getContactInfo

public java.util.Map<java.lang.String,ContactInfo> getContactInfo()
Get the Person's contact information.

The returned Map is of ContactInfo type to ContactInfo.

The list of types can be found in the LIS Person Management Service Information Model, Appendix B1.6

http://imsglobal.org/lis/lisv2p0pd/PMSinfoModelv2p0pd.html

Returns:
The Person's contact information.

getDemographics

public java.util.Map<java.lang.String,Demographics> getDemographics()
Get demographic information about the Person.

The returned Map is of Demographics type to Demographics.

The list of types can be found in the LIS Person Management Service Information Model, Appendix B1.7

http://imsglobal.org/lis/lisv2p0pd/PMSinfoModelv2p0pd.html

Returns:
The demographic information about the Person.

getAgents

public java.util.Map<java.lang.String,Agent> getAgents()
Get the agents who can act on behalf of this Person.

The returned Map is of Agent type to Agent.

The list of types can be found in the LIS Person Management Service Information Model, Appendix B1.11

http://imsglobal.org/lis/lisv2p0pd/PMSinfoModelv2p0pd.html

Returns:
The agents who can act on behalf of this Person.

getRoles

public java.util.List<Roles> getRoles()
Get the user's role information.

Returns:
The user's role information.

addFormattedName

public void addFormattedName(java.lang.String type,
                             FormattedName formattedName)
Add a formatted name to this Person.

Parameters:
type - The formatted name type.
formattedName - The formatted name.

addName

public void addName(java.lang.String type,
                    Name name)
Add a name to this Person.

Parameters:
type - The name type.
name - The name.

addAddress

public void addAddress(java.lang.String type,
                       Address address)
Add an address to this Person.

Parameters:
type - The address type.
address - The address.

addContactInfo

public void addContactInfo(java.lang.String type,
                           ContactInfo contactInfo)
Add contact information to this Person.

Parameters:
type - The contact information type.
contactInfo - The contact information.

addDemographics

public void addDemographics(java.lang.String type,
                            Demographics demographics)
Add demographics information to this Person.

Parameters:
type - The demographics information type.
demographics - The demographics information.

addAgent

public void addAgent(java.lang.String type,
                     Agent agent)
Add an agent to this Person.

Parameters:
type - The agent type.
agent - The agent.

addRoles

public void addRoles(Roles roles)
Add role information to this Person.

Parameters:
roles - The role information to add.

getExtensions

public java.util.Map<java.lang.String,ExtensionField> getExtensions()
Get any custom extensions to the Person data.

The extensions are stored in a Map of extension name to the extension value.

Returns:
any custom extensions to the Person data.

addExtension

public void addExtension(java.lang.String name,
                         ExtensionField f)
Add a custom extension field to this Person.

Parameters:
name - Extension field name
f - Extension field.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.