com.webmethods.caf.faces.data.dir
Interface IPrincipalProvider

All Known Subinterfaces:
IGroupProvider, IRoleProvider, IUserProvider
All Known Implementing Classes:
GroupModel, PrincipalModel, RoleModel, SimpleWrappedPrincipalModel, UserModel

public interface IPrincipalProvider

Base interface for directory objects content providers: users, groups and roles.


Method Summary
 Map getAttributes()
          Get all attributes as a Map.
 String getDisplayName()
          Get display name for this principal.
 String getEmail()
          Get the defined email address for this principal.
 String getIconURL()
          Get icon URL for this principal.
 String getLink()
          Get the linkable URL to open My Profile page for this principal.
 String getPrincipalDN()
          Get the value of the principal DN.
 String getPrincipalID()
          Get the principal object internal ID.
 String getPrincipalURIAsString()
          Get the internal principal object URI as String.
 void setPrincipalAlias(String alias)
          Sets principal alias and initialized this content provider with principal data identified by this alias
 void setPrincipalDN(String dn)
          Sets principal DN and initializes this content provider with principal data identified by this DN.
 void setPrincipalID(String principalID)
          Sets principal internal ID and initializes this content provider with principal data identified by this ID
 

Method Detail

getPrincipalDN

String getPrincipalDN()
Get the value of the principal DN.

Returns:
The DN value.

setPrincipalDN

void setPrincipalDN(String dn)
Sets principal DN and initializes this content provider with principal data identified by this DN.

Parameters:
dn - The DN value for this principal.

getPrincipalID

String getPrincipalID()
Get the principal object internal ID.

Returns:
The Id value for this principal.

setPrincipalID

void setPrincipalID(String principalID)
Sets principal internal ID and initializes this content provider with principal data identified by this ID

Parameters:
principalID - The Id value for this principal.

setPrincipalAlias

void setPrincipalAlias(String alias)
Sets principal alias and initialized this content provider with principal data identified by this alias

Parameters:
alias - The alias value for this principal.

getLink

String getLink()
Get the linkable URL to open My Profile page for this principal.

Returns:
The linkable URL as a string.

getIconURL

String getIconURL()
Get icon URL for this principal. Different icons are used for different principal types.

Returns:
The URL for this principal's icon.

getDisplayName

String getDisplayName()
Get display name for this principal. It could be either role or group name, or combination of first and last name for the user

Returns:
The display name for this principal.

getEmail

String getEmail()
Get the defined email address for this principal.

Returns:
The email address for this principal.

getAttributes

Map getAttributes()
Get all attributes as a Map.

Returns:
The attribute map for this principal.

getPrincipalURIAsString

String getPrincipalURIAsString()
Get the internal principal object URI as String.

Returns:
The URI, as a string.