com.ibm.wkplc.people.portal.taglib
Interface PersonCard

public interface PersonCard

PersonCard is the main interface used to generate vcard markup for a person

This is available for cases where user is generating markup in java code, Where person card jsp tag can not be used Usgae is : PersonCard.getInstance().generatePersonCardMarkup ( valueType, value of the valueType, flag to show if the card should be in active or inactive mode Detail about valueType can be found from The supported types for valueType are: EMAIL LDAPDN WMMID Detail about this can be found at http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Integrating_the_Person_card_and_online_status_in_a_custom_portlet_exp8 value is depending on what valueType you have chosen flag by default this is true Writing Person Card using PersonCardOptions personCardOptions = new PersonCardOptions(PersonCardOptions.valueTypes.WMMID,"wpsadmin"); PersonCard.getInstance().generatePersonCardMarkup (personCardOptions); To set person card as inactive call personCardOptions.setIsActive(false); To set person card as active call personCardOptions.setIsActive(true); Tonot include lotusMeta span in person card personCardOptions.setIncludeLotusTag(false); To set your customized displayname personCardOptions.setDisplayName("dilip.sah.kumar"); Finally call PersonCard.getInstance().generatePersonCardMarkup (personCardOptions);

Since:

8.0

Field Summary

static PersonCard

INSTANCE This is access method for generating vcard markup.

Method Summary

java.lang.String	generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext, java.lang.String valueType, java.lang.String value)
java.lang.String	generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext, java.lang.String valueType, java.lang.String value, boolean isActive)
java.lang.String	generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext, java.lang.String valueType, java.lang.String value, java.lang.String displayName, boolean includeLotusTag)
java.lang.String	generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext, java.lang.String valueType, java.lang.String value, java.lang.String displayName, boolean includeLotusTag, boolean isActive)
java.lang.String	generatePersonCardMarkup(PersonCardOptions personCardOptions) Use this method instead of its other variants which has been provided to maintain backward compatibility
java.lang.String	generatePersonCardMarkup(java.lang.String valueType, java.lang.String value)
java.lang.String	generatePersonCardMarkup(java.lang.String valueType, java.lang.String value, boolean isActive)
java.lang.String	generatePersonCardMarkup(java.lang.String valueType, java.lang.String value, boolean includeLotusTag, boolean isActive)
java.lang.String	generatePersonCardMarkup(java.lang.String valueType, java.lang.String value, java.lang.String displayName, boolean includeLotusTag)
java.lang.String	generatePersonCardMarkup(java.lang.String valueType, java.lang.String value, java.lang.String displayName, boolean includeLotusTag, boolean isActive)

Field Detail

INSTANCE

static final PersonCard INSTANCE

This is access method for generating vcard markup. Usage: String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("EMAIL","myemail@domain.com"); To generate markup for inactive person or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("EMAIL","myemail@domain.com",false); To show card as inactive To generate markup for active person String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("EMAIL","myemail@domain.com"); Other examples String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("EMAIL","myemail@domain.com",true); or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("EMAIL","myemail@domain.com",false); To show card as inactive or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup(PageContext,"EMAIL","myemail@domain.com",true); or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("WMMID","myuid",true); or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("WMMID","myuid",false); To show card as inactive or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("WMMID","myuid"); or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup(PageContext,"WMMID","myuid"); or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("LDAPDN","uid=myuid,dc=ibm,dn=com"); or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("LDAPDN","uid=myuid,dc=ibm,dn=com",true); or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup("LDAPDN","uid=myuid,dc=ibm,dn=com",false); To show card as inactive or String vcardmarkup = PersonCard.INSTANCE.generatePersonCardMarkup(PageContext,"LDAPDN","uid=myuid,dc=ibm,dn=com",false); To show card as inactive PersonCardOptions personCardOptions = new PersonCardOptions(PersonCardOptions.valueTypes.WMMID,"wpsadmin"); PersonCard.getInstance().generatePersonCardMarkup (personCardOptions); To set person card as inactive call personCardOptions.setIsActive(false); To set person card as active call personCardOptions.setIsActive(true); Tonot include lotusMeta span in person card personCardOptions.setIncludeLotusTag(false); To set your customized displayname personCardOptions.setDisplayName("dilip.sah.kumar"); Finally call PersonCard.getInstance().generatePersonCardMarkup (personCardOptions);

Method Detail

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(PersonCardOptions personCardOptions)
                                          throws InvalidPersonCardOptions

Use this method instead of its other variants which has been provided to maintain backward compatibility

Parameters:

personCardOptions - : Use this class different member variable to set options for person card

Returns:

this method returns vcard markup as string

Throws:

InvalidPersonCardOptions - , if any of value or valueType mentioned in personCardOptions is null

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(java.lang.String valueType,
                                          java.lang.String value,
                                          boolean isActive)

Parameters:

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter

isActive - : true for showing active card false to show inactive person

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(java.lang.String valueType,
                                          java.lang.String value,
                                          boolean includeLotusTag,
                                          boolean isActive)

Parameters:

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter

isActive - : true for showing active card false to show inactive person

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(java.lang.String valueType,
                                          java.lang.String value)

Parameters:

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter valueType

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext,
                                          java.lang.String valueType,
                                          java.lang.String value)

Parameters:

pageContext - : PageContext object

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter valueType

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext,
                                          java.lang.String valueType,
                                          java.lang.String value,
                                          boolean isActive)

Parameters:

pageContext - : PageContext object

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter valueType

isActive - : true for showing active card false to show inactive person

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(java.lang.String valueType,
                                          java.lang.String value,
                                          java.lang.String displayName,
                                          boolean includeLotusTag,
                                          boolean isActive)

Parameters:

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter

displayName - : provide a string if you want to use your own value for displayName else a default mechanism will be used

includeLotusTag - : if true, span with class lotusMeta will be included in markup else it will be assumed that it is already being used in parent tags

isActive - : true for showing active card false to show inactive person

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(java.lang.String valueType,
                                          java.lang.String value,
                                          java.lang.String displayName,
                                          boolean includeLotusTag)

Parameters:

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter valueType

displayName - : provide a string if you want to use your own value for displayName else a default mechanism will be used

includeLotusTag - : if true, span with class lotusMeta will be included in markup else it will be assumed that it is already being used in parent tags

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext,
                                          java.lang.String valueType,
                                          java.lang.String value,
                                          java.lang.String displayName,
                                          boolean includeLotusTag)

Parameters:

pageContext - : PageContext object

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter valueType

displayName - : provide a string if you want to use your own value for displayName else a default mechanism will be used

includeLotusTag - : if true, span with class lotusMeta will be included in markup else it will be assumed that it is already being used in parent tags

Returns:

this method returns vcard markup as string

generatePersonCardMarkup

java.lang.String generatePersonCardMarkup(javax.servlet.jsp.PageContext pageContext,
                                          java.lang.String valueType,
                                          java.lang.String value,
                                          java.lang.String displayName,
                                          boolean includeLotusTag,
                                          boolean isActive)

Parameters:

pageContext - : PageContext object

valueType - : "EMAIL","LDAPDN","WMMID"

value - : as per first parameter valueType

displayName - : provide a string if you want to use your own value for displayName else a default mechanism will be used

includeLotusTag - : if true, span with class lotusMeta will be included in markup else it will be assumed that it is already being used in parent tags

isActive - : true for showing active card false to show inactive person

Returns:

this method returns vcard markup as string