blackboard.dataintegration.ims.data
Class Role

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

public class Role
extends java.lang.Object

Contains information about a Member's Role in IMS Enterprise 1.1 XML.

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 Role.RoleType
          The Member's function within a group.
static class Role.Status
          Indicates if a Member is active or inactive in the Group.
 
Constructor Summary
Role()
           
 
Method Summary
 java.lang.String getComments()
          Get the description of the current status.
 java.lang.String getDatasource()
          Get the identifier of the source system of this Role.
 java.util.Calendar getDatetime()
          Get the date the current membership was established.
 java.lang.String getEmail()
          Get the email address used to contact a member for information related to the specific Group membership.
 java.lang.String getExtension()
          Get an XML string containing the custom extension data for this Role.
 Recstatus getRecstatus()
          Get the type of operation to be performed on this Role.
 Role.RoleType getRoletype()
          Get the type of this role.
 Role.Status getStatus()
          Get the status of this role.
 java.lang.String getSubrole()
          Get the sub type of this Role.
 TimeFrame getTimeframe()
          Get the timeframe of the Membership.
 UserId getUserid()
          Get the Person's user ID to access the Group within this Role's Membership
 void setComments(java.lang.String comments)
          Set the description of the current status.
 void setDatasource(java.lang.String datasource)
          Set the identifier of the source system of this Role.
 void setDatetime(java.util.Calendar datetime)
          Set the date the current membership was established.
 void setEmail(java.lang.String email)
          Set the email address used to contact a member for information related to the specific Group membership.
 void setExtension(java.lang.String extension)
          Set the custom extension data for this Role.
 void setRecstatus(Recstatus recstatus)
          Set the type of operation to be performed on this Role.
 void setRoletype(Role.RoleType roletype)
          Set the type of this role.
 void setStatus(Role.Status status)
          Set the status of this role.
 void setSubrole(java.lang.String subrole)
          Set the sub type of this Role.
 void setTimeframe(TimeFrame timeframe)
          Set the timeframe of the Membership.
 void setUserid(UserId userid)
          Set the Person's user ID to access the Group within this Role's Membership
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Role

public Role()
Method Detail

getComments

public java.lang.String getComments()
Get the description of the current status.

Returns:
The description of the current status.

getDatasource

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

Returns:
The data source.

getDatetime

public java.util.Calendar getDatetime()
Get the date the current membership was established.

Within xml the format is as defined by ISO8601.

Returns:
The date the current membership was established.

getEmail

public java.lang.String getEmail()
Get the email address used to contact a member for information related to the specific Group membership.

Returns:
The contact email address.

getExtension

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

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.

getRecstatus

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

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

getRoletype

public Role.RoleType getRoletype()
Get the type of this role.

Returns:
The type of this role.

getStatus

public Role.Status getStatus()
Get the status of this role.

Returns:
The status of this role.

getSubrole

public java.lang.String getSubrole()
Get the sub type of this Role.

This is an open-ended value as opposed to the RoleType.

Returns:
The sub type of this Role.

getTimeframe

public TimeFrame getTimeframe()
Get the timeframe of the Membership.

Returns:
The timeframe of the Membership.

getUserid

public UserId getUserid()
Get the Person's user ID to access the Group within this Role's Membership

Returns:
The Person's user ID.

setComments

public void setComments(java.lang.String comments)
Set the description of the current status.

Parameters:
comments - The description of the current status.

setDatasource

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

Parameters:
datasource - The data source.

setDatetime

public void setDatetime(java.util.Calendar datetime)
Set the date the current membership was established.

Parameters:
datetime - The date the current membership was established.

setEmail

public void setEmail(java.lang.String email)
Set the email address used to contact a member for information related to the specific Group membership.

Parameters:
email - The contact email address.

setExtension

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

Parameters:
extension - The custom extension data.

setRecstatus

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

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

setRoletype

public void setRoletype(Role.RoleType roletype)
Set the type of this role.

Parameters:
roletype - The type of this role.

setStatus

public void setStatus(Role.Status status)
Set the status of this role.

Parameters:
status - The status of this role.

setSubrole

public void setSubrole(java.lang.String subrole)
Set the sub type of this Role.

This is an open-ended value as opposed to the RoleType.

Parameters:
subrole - The sub type of this Role.

setTimeframe

public void setTimeframe(TimeFrame timeframe)
Set the timeframe of the Membership.

Parameters:
timeframe - The timeframe of the Membership.

setUserid

public void setUserid(UserId userid)
Set the Person's user ID to access the Group within this Role's Membership

Parameters:
userid - The Person's user ID.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.