com.plumtree.portaluiinfrastructure.compoundlist
Class ListEntry

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

public class ListEntry
extends java.lang.Object

Class to hold components of an URL. Used by ASCompoundLists

Author:

robertz

Field Summary

protected int	CommunityID
protected java.lang.String	Control
protected java.lang.String	EditorAS
protected java.lang.String	EditorPage
protected java.lang.String	EditorType
protected int	FolderID
protected java.lang.String	FullURL
protected PTImageType	Image
protected PTImageType	Image2
protected java.lang.String	ImageAltText
protected java.lang.String	Label
protected boolean	m_bIsPreview
protected int	m_nProfileID
protected int	m_nTruncateLength
protected java.lang.String[]	m_paramNames
protected java.lang.String[]	m_paramValues
protected java.lang.String	m_strDescription
protected int	Mode
protected int	NewASType
protected int	PageID
protected int	Type

Constructor Summary

ListEntry(int nType)
Creates a new ListEntry object.

Method Summary

int	GetCommunityID() Gets the Community ID.
java.lang.String	GetControl() Gets the Control ID.
java.lang.String	GetDescription() Gets the Description
java.lang.String	GetEditorAS() Gets the Editor Activityspace ID
java.lang.String	GetEditorType() Gets the editorType.
int	GetFolderID() Gets the FolderID for Directory
java.lang.String	GetFullURL() Gets the Full URL
PTImageType	GetImage() Gets the image.
PTImageType	GetImage2() Gets the second image.
java.lang.String	GetImageAltTextEncoded() Gets the imageAltText.
boolean	GetIsPreview()
java.lang.String	GetLabel() Gets the encoded and truncated label.
int	GetMode() Gets the Mode
int	GetNewASType() Gets the newASType.
java.lang.String	GetOrigLabel() Gets the encoded but untruncated label.
java.lang.String	GetPage() Gets the Editor Page
int	GetPageID() Gets the Page ID.
java.lang.String[]	GetParamNames() Gets the parameter names array
java.lang.String[]	GetParamValues() Gets the parameter value array
int	GetProfileID() Gets the profile ID
int	GetType() Gets the editor type.
void	SetCommunityID(int communityID) Sets the communityID.
void	SetControl(java.lang.String control) Sets the control.
void	SetDescription(java.lang.String strDescription) Sets the description.
void	SetEditorAS(java.lang.String editorAS) Sets the editorAS.
void	SetEditorType(int editorType) Sets the editorType.
void	SetExtraParams(java.lang.String[] paramNames, java.lang.String[] paramValues) Set additional parameters
void	SetFolderID(int folderID) Sets the folderID for directory
void	SetFullURL(java.lang.String fullURL) Sets the fullURL.
void	SetImage(PTImageType image) Sets the image.
void	SetImage2(PTImageType image) Sets the image.
void	SetImageAltText(java.lang.String imageAltText) Sets the imageAltText.
void	SetIsPreview(boolean bIsPreview) Sets if the current page is a preview
void	SetLabel(java.lang.String label) Sets the label.
void	SetMode(int mode) Sets the Mode for directory
void	SetNewASType(int newASType) Sets the newASType.
void	SetPage(java.lang.String editorPage) Sets the editorPage.
void	SetPageID(int pageID) Sets the pageID.
void	SetProfileID(int i) Sets the profile ID
void	SetTruncationLength(int nMax) Sets the label truncation width
void	SetType(int type) Sets the type.

Methods inherited from class java.lang.Object

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

Field Detail

Image

protected PTImageType Image

Image2

protected PTImageType Image2

Control

protected java.lang.String Control

EditorAS

protected java.lang.String EditorAS

EditorPage

protected java.lang.String EditorPage

EditorType

protected java.lang.String EditorType

FullURL

protected java.lang.String FullURL

ImageAltText

protected java.lang.String ImageAltText

Label

protected java.lang.String Label

m_strDescription

protected java.lang.String m_strDescription

m_paramNames

protected java.lang.String[] m_paramNames

m_paramValues

protected java.lang.String[] m_paramValues

CommunityID

protected int CommunityID

FolderID

protected int FolderID

m_nProfileID

protected int m_nProfileID

m_bIsPreview

protected boolean m_bIsPreview

Mode

protected int Mode

NewASType

protected int NewASType

PageID

protected int PageID

Type

protected int Type

m_nTruncateLength

protected int m_nTruncateLength

Constructor Detail

ListEntry

public ListEntry(int nType)

Creates a new ListEntry object.

Parameters:

nType - Link type

Method Detail

GetCommunityID

public int GetCommunityID()

Gets the Community ID.

Returns:

Community integer ID

GetControl

public java.lang.String GetControl()

Gets the Control ID.

Returns:

Control String ID

GetDescription

public java.lang.String GetDescription()

Gets the Description

Returns:

Description String, empty String if none exists

GetEditorAS

public java.lang.String GetEditorAS()

Gets the Editor Activityspace ID

Returns:

Activityspace String ID

GetEditorType

public java.lang.String GetEditorType()

Gets the editorType.

Returns:

Editor int type

GetFolderID

public int GetFolderID()

Gets the FolderID for Directory

Returns:

Folder int ID

GetFullURL

public java.lang.String GetFullURL()

Gets the Full URL

Returns:

Full URL String

GetImage

public PTImageType GetImage()

Gets the image.

Returns:

Image construct

GetImage2

public PTImageType GetImage2()

Gets the second image.

Returns:

Image construct

GetImageAltTextEncoded

public java.lang.String GetImageAltTextEncoded()

Gets the imageAltText.

Returns:

Image Alt String

GetLabel

public java.lang.String GetLabel()

Gets the encoded and truncated label.

Returns:

Truncated and HTML encoded String

GetOrigLabel

public java.lang.String GetOrigLabel()

Gets the encoded but untruncated label.

Returns:

HTML encoded String

GetMode

public int GetMode()

Gets the Mode

Returns:

int

GetNewASType

public int GetNewASType()

Gets the newASType.

Returns:

int

GetPage

public java.lang.String GetPage()

Gets the Editor Page

Returns:

Editor String Page

GetPageID

public int GetPageID()

Gets the Page ID.

Returns:

Page integer ID

GetParamNames

public java.lang.String[] GetParamNames()

Gets the parameter names array

Returns:

Array of parameter names

GetParamValues

public java.lang.String[] GetParamValues()

Gets the parameter value array

Returns:

Array of parameter values

GetType

public int GetType()

Gets the editor type.

Returns:

integer type

GetIsPreview

public boolean GetIsPreview()

SetCommunityID

public void SetCommunityID(int communityID)

Sets the communityID.

Parameters:

communityID - The community ID

SetControl

public void SetControl(java.lang.String control)

Sets the control.

Parameters:

control - The String Control

SetDescription

public void SetDescription(java.lang.String strDescription)

Sets the description.

Parameters:

strDescription - The description

SetEditorAS

public void SetEditorAS(java.lang.String editorAS)

Sets the editorAS.

Parameters:

editorAS - The Editor Activityspace

SetEditorType

public void SetEditorType(int editorType)

Sets the editorType.

Parameters:

editorType - The editorType

SetExtraParams

public void SetExtraParams(java.lang.String[] paramNames,
                           java.lang.String[] paramValues)

Set additional parameters

Parameters:

paramNames - Array of additional parameter names

paramValues - Array of additional parameter values

SetFolderID

public void SetFolderID(int folderID)

Sets the folderID for directory

Parameters:

folderID - The Folder ID

SetFullURL

public void SetFullURL(java.lang.String fullURL)

Sets the fullURL.

Parameters:

fullURL - The fullURL

SetImage

public void SetImage(PTImageType image)

Sets the image.

Parameters:

image - The image to set

SetImage2

public void SetImage2(PTImageType image)

Sets the image.

Parameters:

image - The second image to set

SetImageAltText

public void SetImageAltText(java.lang.String imageAltText)

Sets the imageAltText.

Parameters:

imageAltText - The imageAltText to set

SetLabel

public void SetLabel(java.lang.String label)

Sets the label.

Parameters:

label - The label to set

SetMode

public void SetMode(int mode)

Sets the Mode for directory

Parameters:

mode - The mode to set

SetNewASType

public void SetNewASType(int newASType)

Sets the newASType.

Parameters:

newASType - The new activityspace type to set

SetPage

public void SetPage(java.lang.String editorPage)

Sets the editorPage.

Parameters:

editorPage - The editor page to set

SetPageID

public void SetPageID(int pageID)

Sets the pageID.

Parameters:

pageID - The page ID to set

SetTruncationLength

public void SetTruncationLength(int nMax)

Sets the label truncation width

Parameters:

nMax - Character position to truncate at

SetType

public void SetType(int type)

Sets the type.

Parameters:

type - The type to set

SetIsPreview

public void SetIsPreview(boolean bIsPreview)

Sets if the current page is a preview

Parameters:

bIsPreview - Is the page a preview page

GetProfileID

public int GetProfileID()

Gets the profile ID

Returns:

The profile ID

SetProfileID

public void SetProfileID(int i)

Sets the profile ID

Parameters:

Sets - profile ID