This class also used in (click to expand):
 
 
 
 
 
                                                Packet.assignEnterpriseRole(ProfileInfo, String)
                                            
 
 
 
 
                                                Packet.assignPersonalRole(ProfileInfo, String)
                                            
 
 
 
 
                                                Packet.assignRole(ProfileInfo, String)
                                            
 
 
 
 
                                                Packet.getProfileRole(String, String)
                                            
 
 
 
 
                                                Packet.getRole(String)
                                            
 
 
 
 
                                                Packet.getRoleByEmail(String)
                                            
 
 
 
 
                                                Packet.getRoles(String)
                                            
 
 
 
 
                                                Packet.getUserRole(String, String)
                                            
 
 
 
 
                                                TransactionPacket.assignEnterpriseRole(ProfileInfo, String)
                                            
 
 
 
 
                                                TransactionPacket.assignPersonalRole(ProfileInfo, String)
                                            
 
 
 
 
                                                TransactionPacket.assignRole(ProfileInfo, String)
                                            
 
 
 
 
                                                TransactionPacket.getProfileRole(String, String)
                                            
 
 
 
 
                                                TransactionPacket.getRole(String)
                                            
 
 
 
 
                                                TransactionPacket.getRoleByEmail(String)
                                            
 
 
 
 
                                                TransactionPacket.getRoles(String)
                                            
 
 
 
 
                                                TransactionPacket.getUserRole(String, String)
                                            
 
 
  
  
 
 
 
 
 
 
 
 
 
 | 
 
 
 
 ProfileInfo
 
 
 
  | 
 
 
 
 
 getProfile()
 
 
 
  Returns profile associated with this role. 
  | 
 
 
 
 | 
 
 
 
 
                                                    String
                                                
 
  | 
 
 
 
 
 getRole()
 
 
 
  Returns the role name. 
  | 
 
 
 
 | 
 
 
 
 
                                                    String
                                                
 
  | 
 
 
 
 
 getStatus()
 
 
 
  Returns the role status. 
  | 
 
 
 
 | 
 
 
 
 
                                                    boolean
                                                
 
  | 
 
 
 
 
 isActive()
 
 
 
  Returns true if this role is the active role for the user. 
  | 
 
 
 
 | 
 
 
 
 
                                                    boolean
                                                
 
  | 
 
 
 
 
 isOwner()
 
 
 
  Returns true if the user associated with the role is the transaction owner (enterprise that owns the related Pal). 
  | 
 
 
 
 | 
 
 
 
 
                                                    boolean
                                                
 
  | 
 
 
 
 
 isRegistered()
 
 
 
  Returns true if the user associated with the role is a registered. 
  | 
 
 
 
 | 
 
 
                                                     
                                                
 
 
 
  | 
 
 
 
 
 revoke()
 
 
 
  Removes the role from the associated user.  You should not attempt to use this Role once it has been revoked. 
  | 
 
 
 
 | 
 
 
                                                     
                                                
 
 
 
  | 
 
 
 
 
 setActive(boolean active)
 
 
 
  Sets this role to be the active role for the user. 
  | 
 
 
 
 | 
 
 
                                                     
                                                
 
 
 
  | 
 
 
 
 
 setStatus(String status)
 
 
 
  Sets the role status. 
  | 
 
 
 
 | 
 
 
 
 
                                                    String
                                                
 
  | 
 
 
 
 
 toString()
 
 
 
  Returns a description of this object. 
  | 
 
 
 
 Method Detail
 
 
 
 ProfileInfo getProfile()
 
 
 
                                    Returns profile associated with this role.
                                
 
 
 
 Returns: 
                                        
 
 ProfileInfo
 
 
 
 
 
 
 
 
 Since:
                                    07-06-2009
                                
 
 
 
 
 
 
 
 String getRole()
 
 
 
                                    Returns the role name.
                                
 
 
 
 Returns: 
                                        
 
 
                                                String
                                            
 
 
 
 
 
 
 Since:
                                    05-18-2011
                                
 
 
 
 
 
 
 
 String getStatus()
 
 
 
                                    Returns the role status.
                                
 
 
 
 Returns: 
                                        
 
 
                                                String
                                            
 
 
 
 
 
 
 Since:
                                    05-18-2011
                                
 
 
 
 
 
 
 
 boolean isActive()
 
 
 
                                    Returns true if this role is the active role for the user.
                                
 
 
 
 Returns: 
                                        
 
 
                                                boolean
                                            
 
 
 
 
 
 
 Since:
                                    05-18-2011
                                
 
 
 
 
 
 
 
 boolean isOwner()
 
 
 
                                    Returns true if the user associated with the role is the transaction owner (enterprise that owns the related Pal).
                                
 
 
 
 Returns: 
                                        
 
 
                                                boolean
                                            
 
 
 
 
 
 
 Since:
                                    05-31-2007
                                
 
 
 
 
 
 
 
 boolean isRegistered()
 
 
 
                                    Returns true if the user associated with the role is a registered.
                                
 
 
 
 Returns: 
                                        
 
 
                                                boolean
                                            
 
 
 
 
 
 
 Since:
                                    11-30-2007
                                
 
 
 
 
 
 
 
 revoke()
 
 
 
                                    Removes the role from the associated user.  You should not attempt to use this Role once it has been revoked.
                                
 
 
 
 
 
 Since:
                                    05-18-2011
                                
 
 
 
 
 
 
 
 setActive(boolean active)
 
 
 
                                    Sets this role to be the active role for the user.
                                
 
 
 Parameters:
 
 
 
 - 
 
 
 
                                                            boolean
                                                        
 
                                                     
                                                    active
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 
 
 
 
 
 
 
 Since:
                                    05-18-2011
                                
 
 
 
 
 
 
 
 setStatus(String status)
 
 
 
                                    Sets the role status.
                                
 
 
 Parameters:
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    status
                                                    
 
 
                                                        Maximum allowed size of parameter: 20
                                                    
 
 
 
 
 
 
 
 
 
 
 
 Since:
                                    05-18-2011
                                
 
 
 
 
 
 
 
 String toString()
 
 
 
                                    Returns a description of this object.
                                
 
 
 
 Returns: 
                                        
 
 
                                                String
                                            
 
 
 
 
 
 
 Since:
                                    06-14-2007