com.plumtree.portaluiinfrastructure.compoundlist
Class ASCompoundList

java.lang.Object
  com.plumtree.portaluiinfrastructure.compoundlist.ASCompoundList

All Implemented Interfaces:

ICPListEntryIterator

public class ASCompoundList
extends java.lang.Object
implements ICPListEntryIterator

List to store different types of URLs, primarily URLs to various portal areas.

Author:

robertz

Field Summary

static int	ENTRYTYPE_COMMPTEMPL
static int	ENTRYTYPE_DIRTEMPL
static int	ENTRYTYPE_DOCTEMPL
static int	ENTRYTYPE_EDITORTEMPL
static int	ENTRYTYPE_FULLINTERNALURL
static int	ENTRYTYPE_FULLURL
static int	ENTRYTYPE_GENERICTEMPL
static int	ENTRYTYPE_MYPAGETEMPL
static int	ENTRYTYPE_PREFSTEMPL
static int	ENTRYTYPE_SITEMAPROOTTEMPL
static int	ENTRYTYPE_STRINGLABEL Constant values of the different types of URLs the list stores.
static int	ENTRYTYPE_USERTEMPL
static int	NEWASTYPE_CREATENEW Constant values of the different types of getting the Activity Space.
static int	NEWASTYPE_GETCACHED
static int	NEWASTYPE_GETIFCACHED

Constructor Summary

ASCompoundList()
Creates a new ASCompoundList object.

Method Summary

void	AddCommPageURL(java.lang.String label, int nCommID, int nPageID) Adds a Community page URL
void	AddCommPageURL(java.lang.String label, int nCommID, int nPageID, java.lang.String strDescription, int nProfileID) Adds a User Profile Community Page URL
void	AddCommPreviewPageURL(java.lang.String label, int nCommID, int nPageID, java.lang.String strDescription) Adds a Community Preview URL
void	AddCompoundList(ICPListEntryIterator list) Adds the content of another ASCompoundList
void	AddDirectoryURL(java.lang.String label, int nMode, int nFolderID) Adds a Directory URL
void	AddDirectoryURL(java.lang.String label, int nMode, int nFolderID, java.lang.String strDescription) Adds a Directory URL with description
void	AddDocumentURL(java.lang.String label, int nDocID) Adds an URL to a directory document
void	AddDocumentURL(java.lang.String label, int nDocID, java.lang.String strDescription) Adds an URL to a directory document with description
void	AddEditorPageURL(java.lang.String label, java.lang.String editor, java.lang.String control, int nEditorType) Adds an URL to an editor
void	AddEditorPageURL(java.lang.String label, java.lang.String editor, java.lang.String control, java.lang.String page, java.lang.String[] paramNames, java.lang.String[] paramValues) Adds an URL to an editor with additional parameters.
void	AddFullURL(java.lang.String label, java.lang.String url) Adds an external URL
void	AddFullURL(java.lang.String label, java.lang.String url, java.lang.String strDescription) Adds an external URL with description
void	AddGenericURL(java.lang.String label, java.lang.String strAS, java.lang.String[] paramNames, java.lang.String[] paramValues, int nNewASType) Adds a generic portal URL
void	AddInternalFullURL(java.lang.String label, java.lang.String url) Adds a full URL for a portal page Use this URL type instead of AddFullURL for portal pages since ENTRYTYPE_FULLURL URL type will open in a popup if displayoptions specify external URL to open in a pop.
void	AddLabel(java.lang.String label) Adds just a label
void	AddMyPageURL(java.lang.String label, int nPageID) Adds a Mypage URL
void	AddPreferencesURL(java.lang.String label, java.lang.String strPrefsPage) Adds a User Preference Page URL
void	AddSiteMapRootURL(java.lang.String label, int nCommID, int nMode, boolean bIsPreview) Adds a Community Knowledge Directory Root URL
void	AddUserProfileURL(java.lang.String label, int nUserID) Adds a User Profile URL
void	AddUserProfileURL(java.lang.String label, int nUserID, java.lang.String strDescription) Adds a User Profile URL with description
ListEntry	GetEntry() Gets the current entry ResetIterator and GetNextEntry will get the first entry in the list.
ListEntry	GetEntryAtIndex(int nIndex) Gets an entry at a specific entry
void	GetIterator() Reset the Iterator
int	GetTotalCount() Get the number of entries in the list
boolean	Next() Advances the iterator to next entry
void	SetImageForLastAddedURL(PTImageType image, PTImageType image2, java.lang.String strImageAltText) Assigns a two part image to the entry last added to the list
void	SetImageForLastAddedURL(PTImageType image, java.lang.String strImageAltText) Assigns an image to the entry last added to the list
void	SetImageForLastAddedURL(java.lang.String strImagePath, java.lang.String strImageAltText) Not for general use Only added for converting IPTURLs to ListEntry URLs in NavigationModel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTRYTYPE_STRINGLABEL

public static final int ENTRYTYPE_STRINGLABEL

Constant values of the different types of URLs the list stores.

See Also:

Constant Field Values

ENTRYTYPE_FULLURL

public static final int ENTRYTYPE_FULLURL

See Also:

Constant Field Values

ENTRYTYPE_COMMPTEMPL

public static final int ENTRYTYPE_COMMPTEMPL

See Also:

Constant Field Values

ENTRYTYPE_MYPAGETEMPL

public static final int ENTRYTYPE_MYPAGETEMPL

See Also:

Constant Field Values

ENTRYTYPE_DIRTEMPL

public static final int ENTRYTYPE_DIRTEMPL

See Also:

Constant Field Values

ENTRYTYPE_EDITORTEMPL

public static final int ENTRYTYPE_EDITORTEMPL

See Also:

Constant Field Values

ENTRYTYPE_PREFSTEMPL

public static final int ENTRYTYPE_PREFSTEMPL

See Also:

Constant Field Values

ENTRYTYPE_GENERICTEMPL

public static final int ENTRYTYPE_GENERICTEMPL

See Also:

Constant Field Values

ENTRYTYPE_DOCTEMPL

public static final int ENTRYTYPE_DOCTEMPL

See Also:

Constant Field Values

ENTRYTYPE_USERTEMPL

public static final int ENTRYTYPE_USERTEMPL

See Also:

Constant Field Values

ENTRYTYPE_SITEMAPROOTTEMPL

public static final int ENTRYTYPE_SITEMAPROOTTEMPL

See Also:

Constant Field Values

ENTRYTYPE_FULLINTERNALURL

public static final int ENTRYTYPE_FULLINTERNALURL

See Also:

Constant Field Values

NEWASTYPE_CREATENEW

public static final int NEWASTYPE_CREATENEW

Constant values of the different types of getting the Activity Space.

See Also:

Constant Field Values

NEWASTYPE_GETCACHED

public static final int NEWASTYPE_GETCACHED

See Also:

Constant Field Values

NEWASTYPE_GETIFCACHED

public static final int NEWASTYPE_GETIFCACHED

See Also:

Constant Field Values

Constructor Detail

ASCompoundList

public ASCompoundList()

Creates a new ASCompoundList object.

Method Detail

AddCommPageURL

public void AddCommPageURL(java.lang.String label,
                           int nCommID,
                           int nPageID)

Adds a Community page URL

Parameters:

label - String to display

nCommID - Community ID

nPageID - Community Page ID

AddCommPageURL

public void AddCommPageURL(java.lang.String label,
                           int nCommID,
                           int nPageID,
                           java.lang.String strDescription,
                           int nProfileID)

Adds a User Profile Community Page URL

Parameters:

label - String to display

nCommID - Community ID

nPageID - Community Page ID

strDescription - Description for the user profile

nProfileID - Profile User ID

AddCommPreviewPageURL

public void AddCommPreviewPageURL(java.lang.String label,
                                  int nCommID,
                                  int nPageID,
                                  java.lang.String strDescription)

Adds a Community Preview URL

Parameters:

label - String to display

nCommID - Community ID

nPageID - Communiyt Page ID

strDescription - Description for the Community

AddSiteMapRootURL

public void AddSiteMapRootURL(java.lang.String label,
                              int nCommID,
                              int nMode,
                              boolean bIsPreview)

Adds a Community Knowledge Directory Root URL

Parameters:

label - String to display

nCommID - Community ID

nMode - Browse or Edit Mode

bIsPreview - Is this page in preview mode

AddCompoundList

public void AddCompoundList(ICPListEntryIterator list)

Adds the content of another ASCompoundList

Parameters:

list - ASCompoundList, does nothing if null

AddDirectoryURL

public void AddDirectoryURL(java.lang.String label,
                            int nMode,
                            int nFolderID)

Adds a Directory URL

Parameters:

label - String to display

nMode - Browse or Edit Mode

nFolderID - ID of Folder to display

AddDirectoryURL

public void AddDirectoryURL(java.lang.String label,
                            int nMode,
                            int nFolderID,
                            java.lang.String strDescription)

Adds a Directory URL with description

Parameters:

label - String to display

nMode - Browse or Edit Mode

nFolderID - ID of Folder to display

strDescription - Description of folder

AddDocumentURL

public void AddDocumentURL(java.lang.String label,
                           int nDocID)

Adds an URL to a directory document

Parameters:

label - String to display

nDocID - ID of document

AddDocumentURL

public void AddDocumentURL(java.lang.String label,
                           int nDocID,
                           java.lang.String strDescription)

Adds an URL to a directory document with description

Parameters:

label - String to display

nDocID - ID of document

strDescription - Document description

AddEditorPageURL

public void AddEditorPageURL(java.lang.String label,
                             java.lang.String editor,
                             java.lang.String control,
                             int nEditorType)

Adds an URL to an editor

Parameters:

label - String to display

editor - Editor Activityspace ID

control - Editor Control ID

nEditorType - Editor type constant

AddEditorPageURL

public void AddEditorPageURL(java.lang.String label,
                             java.lang.String editor,
                             java.lang.String control,
                             java.lang.String page,
                             java.lang.String[] paramNames,
                             java.lang.String[] paramValues)

Adds an URL to an editor with additional parameters.

Parameters:

label - String to display

editor - Editor Activityspace ID

control - Editor Control ID

page - Editor Page ID

paramNames - String array of parameter names, each name element must have a corresponding value element in paramValues

paramValues - String array of parameter values, each value element must have a corresponding name element in paramNames

AddInternalFullURL

public void AddInternalFullURL(java.lang.String label,
                               java.lang.String url)

Adds a full URL for a portal page Use this URL type instead of AddFullURL for portal pages since ENTRYTYPE_FULLURL URL type will open in a popup if displayoptions specify external URL to open in a pop.

Parameters:

label -

url -

AddFullURL

public void AddFullURL(java.lang.String label,
                       java.lang.String url)

Adds an external URL

Parameters:

label - String to display

url - The full url to an external site (including http://)

AddFullURL

public void AddFullURL(java.lang.String label,
                       java.lang.String url,
                       java.lang.String strDescription)

Adds an external URL with description

Parameters:

label - String to display

url - The full url to an external site (including http://)

strDescription - Description of external URL

AddGenericURL

public void AddGenericURL(java.lang.String label,
                          java.lang.String strAS,
                          java.lang.String[] paramNames,
                          java.lang.String[] paramValues,
                          int nNewASType)

Adds a generic portal URL

Parameters:

label - String to display

strAS - Activityspace ID

paramNames - String array of parameter names, each name element must have a corresponding value element in paramValues

paramValues - String array of parameter values, each value element must have a corresponding name element in paramNames

nNewASType - How to retrieve the activityspace, use NEWSASTYPE_ constant

AddLabel

public void AddLabel(java.lang.String label)

Adds just a label

Parameters:

label - String to display

AddMyPageURL

public void AddMyPageURL(java.lang.String label,
                         int nPageID)

Adds a Mypage URL

Parameters:

label - String to display

nPageID - Mypage ID

AddPreferencesURL

public void AddPreferencesURL(java.lang.String label,
                              java.lang.String strPrefsPage)

Adds a User Preference Page URL

Parameters:

label - String to display

strPrefsPage - Preference Page ID

AddUserProfileURL

public void AddUserProfileURL(java.lang.String label,
                              int nUserID)

Adds a User Profile URL

Parameters:

label - String to display

nUserID - The ID of the user

AddUserProfileURL

public void AddUserProfileURL(java.lang.String label,
                              int nUserID,
                              java.lang.String strDescription)

Adds a User Profile URL with description

Parameters:

label - String to display

nUserID - The ID of the user

strDescription - Description of the user

GetEntry

public ListEntry GetEntry()

Gets the current entry ResetIterator and GetNextEntry will get the first entry in the list.

Specified by:

GetEntry in interface ICPListEntryIterator

Returns:

The current entry in the list

GetEntryAtIndex

public ListEntry GetEntryAtIndex(int nIndex)

Gets an entry at a specific entry

Specified by:

GetEntryAtIndex in interface ICPListEntryIterator

Parameters:

nIndex - Index of the entry

Returns:

Entry at the specified entry

GetIterator

public void GetIterator()

Reset the Iterator

Specified by:

GetIterator in interface ICPListEntryIterator

GetTotalCount

public int GetTotalCount()

Get the number of entries in the list

Specified by:

GetTotalCount in interface ICPListEntryIterator

Returns:

Count of entries in the list

Next

public boolean Next()

Advances the iterator to next entry

Specified by:

Next in interface ICPListEntryIterator

Returns:

False if no more exist, otherwise true

SetImageForLastAddedURL

public void SetImageForLastAddedURL(PTImageType image,
                                    java.lang.String strImageAltText)

Assigns an image to the entry last added to the list

Parameters:

image - Image construct for the image to add

strImageAltText - Alt String for the image

SetImageForLastAddedURL

public void SetImageForLastAddedURL(PTImageType image,
                                    PTImageType image2,
                                    java.lang.String strImageAltText)

Assigns a two part image to the entry last added to the list

Parameters:

image - Image construct for the first image

image2 - Image construct for the second image

strImageAltText - Alt string for both images

SetImageForLastAddedURL

public void SetImageForLastAddedURL(java.lang.String strImagePath,
                                    java.lang.String strImageAltText)

Not for general use Only added for converting IPTURLs to ListEntry URLs in NavigationModel. Only supports icons for Community Actions, My Page actions and Mandatory link entry types

Parameters:

strImagePath -

strImageAltText -