com.plumtree.portalpages.browsing.directory
Class DirModel

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AClearModel
      com.plumtree.portalpages.browsing.directory.DirModel

All Implemented Interfaces:

IDirModel, IDirModelRO, IFolderModel, IFolderModelRO, IObjectModelRO, ITaggingModel, IManagedObject, IModel, IModelRO, IMVCObject, IRepostModel, ISortModelRO

public class DirModel
extends AClearModel
implements IDirModelRO, ISortModelRO, IRepostModel, IDirModel, ITaggingModel

This model contains data for both the Browse and Edit Modes of the Directory.

Author:

StephenC

Field Summary

static int	BEGIN_INDEX index for object range array returned via GetObjectRange()
static int	CARD_CNT
static java.lang.String	CHINESE_LANGUAGE_CODE
static java.lang.String	CHINESE_LOCALE_CODE_CN
static java.lang.String	CHINESE_LOCALE_CODE_HK
static java.lang.String	CHINESE_LOCALE_CODE_MO
static java.lang.String	CHINESE_LOCALE_CODE_SG
static java.lang.String	CHINESE_LOCALE_CODE_TW
static java.lang.String	DEFAULTDATA
static int	END_INDEX
static java.lang.String	ENGLISH_LOCALE_CODE
static int	HEADER_ID_INDEX
static int	HEADER_NAME_INDEX
static int	HEADER_PROPERTIES_SIZE
static int	HEADER_SORT_URL_INDEX
static java.lang.String	HTTP_PREFIX
boolean	m_bOpenDocInNewWindow User Pref settings
int	m_nCurrentCardID For Card Properties
int	m_nCurrentFolderID
protected int	m_nDirMode Directory mode - Browse, Edit, Disability
int	m_nLoadedCardID For Advanced Card Submission to prevent Card Confirmation page from being displayed more than once if the page is refreshed.
int	m_nNumFoldCol Settable Dir Pref
int	m_nRangeBegin Document Range
int	m_nRangeEnd
XPDateTime	m_xpNewTagDate New Document Date
XPArrayList	m_xpPropColumns Sorting Columns
XPDateTime	m_xpUpdateTagDate Updated Document Date
static java.lang.String	STR_MVC_CLASS_NAME Activity space name
static java.lang.String	strCopyTargetFolderTREESUBSPACE
static java.lang.String	strDataSourceTREESUBSPACE
static java.lang.String	strMoveTargetFolderTREESUBSPACE
static int	TOTAL_CNT_INDEX

Fields inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel

m_asOwner

Constructor Summary

DirModel()

Method Summary

void	ABODeleteFolders(int[] arFolderIDs)
boolean	ABOJobIDsToDisplay() This method returns whether or not there are any job IDs to display.
void	AddRemoveObjectTag(java.lang.String tagname, java.lang.String strid, int action, java.lang.String ptsource) Adds/Removes Tag specified for the Object with given ID based on Action specified.
void	AddSelfSelectedRelatedExpert()
int[]	CalculateReportMapping(IPTSearchResponse ptSR, int nCurrentLevel) Generates a mapping to an array that mimics what is returned by IPTFolder.QuerySubFolders()
boolean	CheckFoldersForDelete()
boolean	CheckForActivityRight(int nActivityRight)
void	CleanupTempData() This method is called at the end of every HTTP request by the Interpreter.
void	ClearCardRange()
void	CopyCards(int[] arCardIDs, int nTargetFolder)
void	CopyFolders(int[] arFolderIDs, int nTargetFolder)
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
IXPPropertyBag	CreateCardSubmitUploadPropertyBag(java.lang.String _path, java.lang.String _type, java.lang.String _docID)
void	CreateDirectoryFolder(java.lang.String strName, java.lang.String strDescription) Creates a Directory Folder and calls the PEIs OnBeforeCreateDirectoryFolder and OnAfterCreateDirectoryFolder.
IPTFilter	CreateSubFolderSearchFilter(int nCurrentLevel)
void	DeleteCards(int[] arCardIDs)
void	DeleteFolders(int[] arFolderIDs)
void	doApproval(int[] arCardIDs, int nAction)
boolean	doesPropertyDescribeCard(java.lang.Object[] arCardPropIDs, int nPropID)
boolean	DoNotShowObject(int nIndex) Get whether to show this object or not.
void	Finish() Implement some code to execute when the user clicks on "Finish".
int[]	GetABOJobIDs() This method returns the job IDs for the last ABO deletes, and then clears them.
XPSortedDictionary	GetBasicCardProperties()
IASQueryResult	GetBreadCrumbPath()
int	GetBrowseBy()
int	GetBrowseBySource()
int	GetCardID()
XPSortedDictionary	GetCardInformation()
java.lang.String	GetCardName()
java.lang.String	GetCardName(int nCardID)
int[]	GetCardRange() Returns an array with 4 int, [0] start of range, [1] end of range, [2] card count, [3] total count
int	GetCardRangeBegin()
int	GetCardSubmitDataSource()
int	GetCardSubmitError() Retrieve any errors generated during card submission using the REST API.
int	GetCardSubmitFolder()
int	GetCardSubmitMode()
java.lang.String	GetCardSubmitURL(boolean bIsWebDataSource)
int	GetClassID()
java.lang.String	GetCopyTargetFolderTREESUBSPACE()
int	GetCreatedFolderID()
int	GetCurrentFolderID() Get the id of the current folder.
int	GetCurrentFolderLevel() Get the level of the current folder
java.lang.String	GetCurrentFolderName() Get the name of the current folder.
int	GetCurrentLowerObjectIndex()
int	GetCurrentUpperObjectIndex()
XPSortedDictionary	GetCustomCardProperties()
XPArrayList	GetCustomFields(int _nObjectIndex, XPArrayList xpCustomProps, XPLocale xpLocale, XPTimeZone xpTimeZone) Returns an array list of the values for each custom property in xpCustomProps for the document in index _nObjectIndex.
java.lang.String	GetDataSourceName(int nDataSourceID) returns the name of a given datasource.
java.lang.String	GetDataSourceProviderName(int nDataSourceID)
java.lang.String	GetDataSourceTREESUBSPACE()
int	GetDirectoryMode() Gets the current directory mode - Browse or Edit
boolean	GetDisplayPaginationHiddenInputs() Get whether or not to display the hidden inputs needed by the PaginationControl.
boolean	GetDisplaySortHiddenInputs() Get whether or not to display the hidden inputs needed by the SortControl.
java.lang.String	GetDocDescriptionType()
int	GetDocumentTypeId()
IASQueryResult	GetFilteredDataSources() returns a list of data sources that support Card Submission
int	GetFirstFolderIndex() Get the index of the first folder to display.
int	GetFolderColumnCount() Get the number of columns to display.
java.lang.String	GetFolderDescriptionType()
java.lang.String	GetFolderName(int nFolderID)
IASQueryResult	GetFolderObjectCount() Get a list of object names and the number of those objects in the current folder.
java.lang.String	GetFolderPath(int nFolderID)
IASQueryResult	GetFolderQueryResult() Get an IPTQueryResult containing all of the subfolders of the current folder.
int	GetFolderSearchMapping(int nIndex) Retrieves the index within the SearchResponse that corresponds to the ordering that would have been returned from IPTCatalog.QuerySubfolders()
IPTSearchResponse	GetFolderSearchResponse() Get an IPTSearchResponse containing all of the subfolders of the current folder.
IFolderViewHelper	GetFolderViewHelper() Retrieves the folder view helper.
int	GetHeaderCount() Gets the count of the object headers.
boolean	GetHeaderHasCheckbox() Returns whether the header has a checkbox or not.
IXPList	GetHeaderProperties() Retrieves the headers to be displayed in a array that includes the header's name, property Id, and sort URL if applicaple.
HTMLTableRow	GetHeaderRow() Returns the header row
java.lang.String	GetHeaderText(int nHeaderIndex) Gets the text of the header at the given index.
boolean	GetIsCollapsable() Gets whether or not the object banner should be collapsable.
boolean	GetIsFolderSelected(int nFolderID) This method returns whether or not the requested folder is currently selected.
boolean	GetIsObjectSelected(int nObjectID) This method returns whether or not the requested object ID is currently selected.
int	GetLastFolderIndex() Get the index of the first folder to display.
int	GetLoadedCardID()
int	GetMoreFolderID()
java.lang.Object[][]	GetMoreRelatedResources(int nRelatedResourceID)
java.lang.String	GetMoveTargetFolderTREESUBSPACE()
java.lang.String	GetName() Return the name of the MVC object.
java.lang.Object	GetNewTempData() This method returns a new temporary data object.
int	GetNumDocsPerPage()
int	GetNumFolderColumns()
int	GetNumObjects()
int	GetNumSubSubFolders()
int	GetNumSubSubFoldersToDisplay() Set the number of sub-subfolders to display after the next page..
java.lang.String	GetObjectBannerText() this creates a string with the banner sub-header text.
java.lang.String	GetObjectBannerTitle() Gets the name of the current folder.
int	GetObjectColumnCount() Gets the number of columns of objects
int	GetObjectCount() Gets the count of the objects in the query result.
java.lang.Object	GetObjectFields(int nIndex, int nPropID) Gets the fields from the query result.
int	GetObjectID()
XPDateTime	GetObjectNewTagDate()
int	GetObjectSubType(int nIndex) Get the subtype of the object at the given index.
IXPList	GetObjectTags(int docId) Gets the List of Tags of that are attached to this Object by pathways.
int	GetObjectType() Get the Object Class ID of the type of objects we are currently viewing.
XPDateTime	GetObjectUpdateTagDate()
java.lang.String	GetObjectUUID()
boolean	GetObjectViewIsCollapsed() Get whether the object view is collapsed.
int	GetParentDefaultDataSourceIDRecursive() returns the ID of the Default DataSource for this folder.
int	GetParentFolderID() Get the ID of the parent folder of the current folder.
java.lang.Object[]	GetParentFolderIDs() Get an Object array containing the Integer IDs of all the parent folders (the path) of the current folder.
java.lang.String	GetPath() Get the path to the current folder concatenated with '\'.
XPException	GetPathwaysTaggingError() This method returns an error that happened when Add/Remove/Rename Tag request is sent to pathways.
XPArrayList	GetPropColumns()
Redirect	GetRedirectAfterFinish() Returns the Redirect object (this is were we need to go at the end of the Editor).
IASQueryResult	GetRelatedResource(int lRelatedResourceID)
int[]	GetRelatedResourceIDs()
int	GetRelatedResourcesLocation()
java.lang.String	GetRelatedResourceString(int nRelatedResourceID)
int	GetRRCategory()
int	GetRRObjectID()
IPTSession	GetSession()
boolean	GetShowCheckbox() Returns whether the folders should have checkboxes next to them.
boolean	GetShowFolderBanner() Returns whether the subfolder banner should be shown.
boolean	GetShowPagination() Get whether these objects should use pagination or not.
boolean	GetSortable() Get whether these objects are sortable or not.
int	GetSortDirection() Get the sort direction for the currently sorted header column.
int	GetSortedHeader() Get the column id of the header that is currently sorted (starting with 0).
java.lang.String	GetSpaceID() Get the SpaceID of the parent Activity Space
int	GetSubFolderCount() Get the number of folders at all levels in the hierachy
int	GetSubFolderCount(int nLevel) Get the number of sub folders in the current folder at the specified level.
int	GetSubPortalAccessType()
int	GetTotalResults()
java.lang.String	GetUploadWSURL(int _nDataSourceID) Returns the webservice's upload url if it supports uploads and it is set.
XPLocale	GetUserPrefLocale()
boolean	GetUserPrefOpenDocInNewWindow()
XPTimeZone	GetUserPrefTimeZone()
SearchExecutionWarning	GetWarning() return a warning from the last search query(used in browse by search)
int	GetWebServiceID(int _nDataSourceID)
boolean	HasAccessToApproveCardInFolder()
boolean	HasAccessToEditCard()
boolean	HasAccessToEditFolder()
boolean	HasSelfSelectExpertRightOnThisFolder()
void	Init(AActivitySpace parent) This method initializes the model.
boolean	InRootFolder() Returns true if the current folder is the root folder.
boolean	InUnclassifiedCardsFolder()
boolean	IsAtMaxFolderLevel() This method returns whether or not the current folder is at the max level
boolean	IsDateProperty(int nPropertyID)
boolean	IsRelatedExpert()
boolean	IsTaggingEnabled() True if Pathways is enabled and user can tag items, else false.
boolean	IsValidSimpleSubmitSource(int _nDataSourceID)
boolean	IsWebDataSource(int nDataSourceID) Check if the provider for this data source supports web paths.
void	LoadBrowsingPropColumns()
void	LoadCardProperties()
boolean	LoadFoldersAndDocuments()
void	LoadNewAndUpdatedDates()
void	LoadUserPrefs()
void	MigrateObjects(int nClassID, int[] nObjects, java.lang.String sComment) This method adds objects into the migration queue.
void	MoveCards(int[] arCardIDs, int nTargetFolder)
void	MoveFolders(int[] arFolderIDs, int nTargetFolder)
int	OpenFolderByPath(java.lang.String strPath)
void	OpenSubFolder(int ID) Open the folder with the id ID.
void	RaiseError(java.lang.String strError) Helper method to raise an error
void	RaiseError(java.lang.String strError, java.lang.String strExtended) Helper method to raise an error
int	RefreshItemFromCopyTargetFolderTree() This method gets the selected items from the tree.
int	RefreshItemFromDataSourceTree() This method gets the selected items from the tree.
int	RefreshItemFromMoveTargetFolderTree() This method gets the selected items from the tree.
void	RenameObjectTag(java.lang.String tagname, java.lang.String strid, java.lang.String ptsource, java.lang.String renametag) Renames Tag specified for the Object with given ID.
boolean	RetrieveSubFoldersThroughSearch() This method returns whether or not subfolders queries are performed through search
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
IPTSearchResponse	SearchSubFolders(int nFolderID, int nCurrentLevel)
void	SetCardID(int nCardID)
void	SetCardRange(int nRangeBegin, int nRangeEnd)
void	SetCardSubmitDataSource(int nDataSourceID)
void	SetCardSubmitDescription(java.lang.String strDescription)
void	SetCardSubmitError(int _nErrorCode) Sets the error associated with the card submit.
void	SetCardSubmitFolder(int _nFolderID) Set the folder to use when submitting a document.
void	SetCardSubmitMode(int nCardID)
void	SetCardSubmitName(java.lang.String strName)
void	SetCardSubmitURL(java.lang.String strURL)
void	SetDefaultCardRefreshSettings(int nCardID)
void	SetDirectoryMode(int nMode) Sets the Directory mode - Browse or Edit.
void	SetDocumentTypeId(java.lang.String documentTypeId)
void	SetDocUploadParams(java.lang.String _duID, java.lang.String _duServer)
void	SetFirstItemIndex(int nFirstItemIndex) Set the index of the first folder to display on a page.
void	SetFolderIDAndMode(int ID, int nMode) Opens the requested subfolder and sets the mode as appropriate.
void	SetFoldersForDeleteCheck(boolean bFolders)
void	SetLastItemIndex(int nLastItemIndex) Set the index of the first folder to display on a page.
void	SetLoadedCardID(int nCardID)
void	SetMoreFolderID(int nFolderID)
void	SetNumColumns(int nNumColumns)
void	SetNumDocsPerPage(int _nNumDocsPerPage)
void	SetObjectType(int nNewObjectType) This activity space holds only cards, so no need to change the type.
void	SetPathwaysTaggingError(XPException e) This method sets error that happened when tagging request is sent to pathways.
void	SetRRCategory(int nCategoryID)
void	SetRRObjectID(int nObjectID)
void	SetSaveTempData(boolean _saveTempData)
void	SetSortByPropID(int nSortByPropID)
boolean	ShowFolderActionBanner()
boolean	ShowObjectBanner() Get whether to show the banner or not.
boolean	ShowRelatedResources()
void	StartCardKeywords(int _nCardID) start the keywords section.
void	SubmitCard()
void	SubmitCard(java.lang.String _strPath, int _nCSSelectedDataSource)
void	SubmitCard(java.lang.String _path, java.lang.String _type, java.lang.String _docID)
void	SubmitCardWithPropertyBag(int[] arFolderIDs, java.lang.String strLanguage, int nDocTypeID, int nDataSourceID, IXPPropertyBag pbagCardProp, java.lang.String strCardName, java.lang.String strCardDescription)
void	SubmitCardWithPropertyBag(int nDataSourceID, java.lang.String strCardName, java.lang.String strCardDescription, IXPPropertyBag pbagCardProp, int nFolderID)
boolean	SupportsUpload(int _nDataSourceID) Returns true if the specified data source supports remote document upload.

Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel

CleanupAllData, GetTempData

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Activity space name

See Also:

Constant Field Values

HTTP_PREFIX

public static final java.lang.String HTTP_PREFIX

See Also:

Constant Field Values

ENGLISH_LOCALE_CODE

public static final java.lang.String ENGLISH_LOCALE_CODE

See Also:

Constant Field Values

CHINESE_LANGUAGE_CODE

public static final java.lang.String CHINESE_LANGUAGE_CODE

See Also:

Constant Field Values

CHINESE_LOCALE_CODE_CN

public static final java.lang.String CHINESE_LOCALE_CODE_CN

See Also:

Constant Field Values

CHINESE_LOCALE_CODE_TW

public static final java.lang.String CHINESE_LOCALE_CODE_TW

See Also:

Constant Field Values

CHINESE_LOCALE_CODE_HK

public static final java.lang.String CHINESE_LOCALE_CODE_HK

See Also:

Constant Field Values

CHINESE_LOCALE_CODE_MO

public static final java.lang.String CHINESE_LOCALE_CODE_MO

See Also:

Constant Field Values

CHINESE_LOCALE_CODE_SG

public static final java.lang.String CHINESE_LOCALE_CODE_SG

See Also:

Constant Field Values

DEFAULTDATA

public static final java.lang.String DEFAULTDATA

See Also:

Constant Field Values

strDataSourceTREESUBSPACE

public static final java.lang.String strDataSourceTREESUBSPACE

See Also:

Constant Field Values

strMoveTargetFolderTREESUBSPACE

public static final java.lang.String strMoveTargetFolderTREESUBSPACE

See Also:

Constant Field Values

strCopyTargetFolderTREESUBSPACE

public static final java.lang.String strCopyTargetFolderTREESUBSPACE

See Also:

Constant Field Values

HEADER_PROPERTIES_SIZE

public static final int HEADER_PROPERTIES_SIZE

See Also:

Constant Field Values

HEADER_NAME_INDEX

public static final int HEADER_NAME_INDEX

See Also:

Constant Field Values

HEADER_SORT_URL_INDEX

public static final int HEADER_SORT_URL_INDEX

See Also:

Constant Field Values

HEADER_ID_INDEX

public static final int HEADER_ID_INDEX

See Also:

Constant Field Values

m_nCurrentFolderID

public int m_nCurrentFolderID

m_nCurrentCardID

public int m_nCurrentCardID

For Card Properties

m_nLoadedCardID

public int m_nLoadedCardID

For Advanced Card Submission to prevent Card Confirmation page from being displayed more than once if the page is refreshed.

m_nDirMode

protected int m_nDirMode

Directory mode - Browse, Edit, Disability

m_xpPropColumns

public XPArrayList m_xpPropColumns

Sorting Columns

m_xpNewTagDate

public XPDateTime m_xpNewTagDate

New Document Date

m_xpUpdateTagDate

public XPDateTime m_xpUpdateTagDate

Updated Document Date

m_nRangeBegin

public int m_nRangeBegin

Document Range

m_nRangeEnd

public int m_nRangeEnd

m_bOpenDocInNewWindow

public boolean m_bOpenDocInNewWindow

User Pref settings

m_nNumFoldCol

public int m_nNumFoldCol

Settable Dir Pref

BEGIN_INDEX

public static final int BEGIN_INDEX

index for object range array returned via GetObjectRange()

See Also:

Constant Field Values

END_INDEX

public static final int END_INDEX

See Also:

Constant Field Values

CARD_CNT

public static final int CARD_CNT

See Also:

Constant Field Values

TOTAL_CNT_INDEX

public static final int TOTAL_CNT_INDEX

See Also:

Constant Field Values

Constructor Detail

DirModel

public DirModel()

Method Detail

ABODeleteFolders

public void ABODeleteFolders(int[] arFolderIDs)

Specified by:

ABODeleteFolders in interface IDirModel

ABOJobIDsToDisplay

public boolean ABOJobIDsToDisplay()

Description copied from interface: IDirModelRO

This method returns whether or not there are any job IDs to display.

Specified by:

ABOJobIDsToDisplay in interface IDirModelRO

Returns:

boolean true implies there are job ids to display.

AddSelfSelectedRelatedExpert

public void AddSelfSelectedRelatedExpert()

CheckFoldersForDelete

public boolean CheckFoldersForDelete()

Specified by:

CheckFoldersForDelete in interface IDirModelRO

Returns:

CheckForActivityRight

public boolean CheckForActivityRight(int nActivityRight)

Specified by:

CheckForActivityRight in interface IDirModelRO

Parameters:

nActivityRight -

Returns:

CleanupTempData

public void CleanupTempData()

Description copied from interface: IModel

This method is called at the end of every HTTP request by the Interpreter. The Interpreter calls AActivitySpace.CleanupTempData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for cleaning up temporary data that is only used for the lifetime of a single request, like DB query results.

Specified by:

CleanupTempData in interface IModel

Overrides:

CleanupTempData in class AClearModel

See Also:

IModel.CleanupTempData()

CopyCards

public void CopyCards(int[] arCardIDs,
                      int nTargetFolder)

Specified by:

CopyCards in interface IDirModel

CopyFolders

public void CopyFolders(int[] arFolderIDs,
                        int nTargetFolder)

Specified by:

CopyFolders in interface IDirModel

Create

public java.lang.Object Create()

Description copied from class: AClearModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class AClearModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

CreateDirectoryFolder

public void CreateDirectoryFolder(java.lang.String strName,
                                  java.lang.String strDescription)

Description copied from interface: IDirModel

Creates a Directory Folder and calls the PEIs OnBeforeCreateDirectoryFolder and OnAfterCreateDirectoryFolder.

Specified by:

CreateDirectoryFolder in interface IDirModel

Parameters:

strName - Folder Name

strDescription - Folder Description

DeleteCards

public void DeleteCards(int[] arCardIDs)

Specified by:

DeleteCards in interface IDirModel

RaiseError

public void RaiseError(java.lang.String strError,
                       java.lang.String strExtended)

Helper method to raise an error

Parameters:

strError - - Error message

strError - - Extended error message

RaiseError

public void RaiseError(java.lang.String strError)

Helper method to raise an error

Parameters:

strError - - Error message

DeleteFolders

public void DeleteFolders(int[] arFolderIDs)

Specified by:

DeleteFolders in interface IDirModel

MigrateObjects

public void MigrateObjects(int nClassID,
                           int[] nObjects,
                           java.lang.String sComment)

Description copied from interface: IDirModel

This method adds objects into the migration queue.

Specified by:

MigrateObjects in interface IDirModel

DoNotShowObject

public boolean DoNotShowObject(int nIndex)

Description copied from interface: IObjectModelRO

Get whether to show this object or not.

Specified by:

DoNotShowObject in interface IObjectModelRO

Returns:

boolean true implies object is hidden, false implies show object

See Also:

IObjectModelRO.DoNotShowObject(int)

Finish

public void Finish()

Description copied from interface: IRepostModel

Implement some code to execute when the user clicks on "Finish".

Specified by:

Finish in interface IRepostModel

GetABOJobIDs

public int[] GetABOJobIDs()

Description copied from interface: IDirModelRO

This method returns the job IDs for the last ABO deletes, and then clears them.

Specified by:

GetABOJobIDs in interface IDirModelRO

Returns:

int[] an array of job IDs for folder deletions.

GetBasicCardProperties

public XPSortedDictionary GetBasicCardProperties()

Specified by:

GetBasicCardProperties in interface IDirModelRO

Returns:

GetBrowseBy

public int GetBrowseBy()

Specified by:

GetBrowseBy in interface IDirModelRO

Returns:

GetBrowseBySource

public int GetBrowseBySource()

Specified by:

GetBrowseBySource in interface IDirModelRO

Returns:

GetCardID

public int GetCardID()

Specified by:

GetCardID in interface IDirModelRO

Returns:

GetLoadedCardID

public int GetLoadedCardID()

Returns:

SetLoadedCardID

public void SetLoadedCardID(int nCardID)

GetCardInformation

public XPSortedDictionary GetCardInformation()

Specified by:

GetCardInformation in interface IDirModelRO

Returns:

GetCardName

public java.lang.String GetCardName(int nCardID)

Specified by:

GetCardName in interface IDirModelRO

Parameters:

nCardID -

Returns:

GetCardName

public java.lang.String GetCardName()

Specified by:

GetCardName in interface IDirModelRO

Returns:

StartCardKeywords

public void StartCardKeywords(int _nCardID)

start the keywords section.

GetObjectID

public int GetObjectID()

Specified by:

GetObjectID in interface IDirModelRO

Returns:

GetObjectUUID

public java.lang.String GetObjectUUID()

Specified by:

GetObjectUUID in interface IDirModelRO

Returns:

GetClassID

public int GetClassID()

Specified by:

GetClassID in interface IDirModelRO

Returns:

See Also:

ILocNamesModelRO.GetClassID()

GetCardRangeBegin

public int GetCardRangeBegin()

Specified by:

GetCardRangeBegin in interface IDirModelRO

Returns:

GetCardSubmitDataSource

public int GetCardSubmitDataSource()

Specified by:

GetCardSubmitDataSource in interface IDirModelRO

Returns:

GetCardSubmitURL

public java.lang.String GetCardSubmitURL(boolean bIsWebDataSource)

Specified by:

GetCardSubmitURL in interface IDirModelRO

Parameters:

bIsWebDataSource -

Returns:

GetCardSubmitError

public int GetCardSubmitError()

Description copied from interface: IDirModelRO

Retrieve any errors generated during card submission using the REST API.

Specified by:

GetCardSubmitError in interface IDirModelRO

Returns:

The error generated during card submission. -1 if there was no error.

GetCopyTargetFolderTREESUBSPACE

public java.lang.String GetCopyTargetFolderTREESUBSPACE()

Specified by:

GetCopyTargetFolderTREESUBSPACE in interface IDirModelRO

Returns:

GetCreatedFolderID

public int GetCreatedFolderID()

Specified by:

GetCreatedFolderID in interface IDirModelRO

Returns:

GetCurrentFolderID

public int GetCurrentFolderID()

Description copied from interface: IFolderModelRO

Get the id of the current folder.

Specified by:

GetCurrentFolderID in interface IFolderModelRO

See Also:

IFolderModelRO.GetCurrentFolderID()

GetCurrentFolderLevel

public int GetCurrentFolderLevel()

Description copied from interface: IFolderModelRO

Get the level of the current folder

Specified by:

GetCurrentFolderLevel in interface IFolderModelRO

See Also:

IFolderModelRO.GetCurrentFolderLevel()

GetCurrentFolderName

public java.lang.String GetCurrentFolderName()

Description copied from interface: IFolderModelRO

Get the name of the current folder.

Specified by:

GetCurrentFolderName in interface IFolderModelRO

See Also:

IFolderModelRO.GetCurrentFolderName()

GetCurrentLowerObjectIndex

public int GetCurrentLowerObjectIndex()

See Also:

com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentLowerObjectIndex()

GetCurrentUpperObjectIndex

public int GetCurrentUpperObjectIndex()

See Also:

com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentUpperObjectIndex()

GetCustomCardProperties

public XPSortedDictionary GetCustomCardProperties()

Specified by:

GetCustomCardProperties in interface IDirModelRO

Returns:

GetDataSourceName

public java.lang.String GetDataSourceName(int nDataSourceID)

Description copied from interface: IDirModelRO

returns the name of a given datasource.

Specified by:

GetDataSourceName in interface IDirModelRO

Parameters:

nDataSourceID -

Returns:

GetDataSourceProviderName

public java.lang.String GetDataSourceProviderName(int nDataSourceID)

GetDataSourceTREESUBSPACE

public java.lang.String GetDataSourceTREESUBSPACE()

Specified by:

GetDataSourceTREESUBSPACE in interface IDirModelRO

Returns:

GetDirectoryMode

public int GetDirectoryMode()

Gets the current directory mode - Browse or Edit

Specified by:

GetDirectoryMode in interface IDirModelRO

Returns:

int Directory mode constant

GetDisplayPaginationHiddenInputs

public boolean GetDisplayPaginationHiddenInputs()

Description copied from interface: IObjectModelRO

Get whether or not to display the hidden inputs needed by the PaginationControl. This is only useful if GetShowPagination() returns true.

Specified by:

GetDisplayPaginationHiddenInputs in interface IObjectModelRO

Returns:

boolean true implies display hidden inputs

See Also:

IObjectModelRO.GetDisplayPaginationHiddenInputs()

GetDisplaySortHiddenInputs

public boolean GetDisplaySortHiddenInputs()

Description copied from interface: IObjectModelRO

Get whether or not to display the hidden inputs needed by the SortControl. This is only useful if GetSortable() returns true.

Specified by:

GetDisplaySortHiddenInputs in interface IObjectModelRO

Returns:

boolean true implies display hidden inputs

See Also:

IObjectModelRO.GetDisplaySortHiddenInputs()

GetDocDescriptionType

public java.lang.String GetDocDescriptionType()

Specified by:

GetDocDescriptionType in interface IDirModelRO

GetFilteredDataSources

public IASQueryResult GetFilteredDataSources()

Description copied from interface: IDirModelRO

returns a list of data sources that support Card Submission

Specified by:

GetFilteredDataSources in interface IDirModelRO

Returns:

GetFirstFolderIndex

public int GetFirstFolderIndex()

Description copied from interface: IFolderModelRO

Get the index of the first folder to display.

Specified by:

GetFirstFolderIndex in interface IFolderModelRO

See Also:

IFolderModelRO.GetFirstFolderIndex()

GetFolderColumnCount

public int GetFolderColumnCount()

Description copied from interface: IFolderModelRO

Get the number of columns to display.

Specified by:

GetFolderColumnCount in interface IFolderModelRO

See Also:

IFolderModelRO.GetFolderColumnCount()

GetFolderDescriptionType

public java.lang.String GetFolderDescriptionType()

Specified by:

GetFolderDescriptionType in interface IDirModelRO

Returns:

GetFolderName

public java.lang.String GetFolderName(int nFolderID)

Specified by:

GetFolderName in interface IDirModelRO

Parameters:

nFolderID -

Returns:

GetFolderObjectCount

public IASQueryResult GetFolderObjectCount()

Description copied from interface: IFolderModelRO

Get a list of object names and the number of those objects in the current folder. The list will have PT_PROPID_CLASSID ("filter 32") and PT_PROPID_OBJECTCOUNT (12).

Specified by:

GetFolderObjectCount in interface IFolderModelRO

See Also:

IFolderModelRO.GetFolderObjectCount()

GetFolderPath

public java.lang.String GetFolderPath(int nFolderID)

Specified by:

GetFolderPath in interface IDirModelRO

Parameters:

nFolderID -

Returns:

GetFolderQueryResult

public IASQueryResult GetFolderQueryResult()

Description copied from interface: IFolderModelRO

Get an IPTQueryResult containing all of the subfolders of the current folder.

Specified by:

GetFolderQueryResult in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderData()

GetFolderSearchResponse

public IPTSearchResponse GetFolderSearchResponse()

Description copied from interface: IDirModelRO

Get an IPTSearchResponse containing all of the subfolders of the current folder.

Specified by:

GetFolderSearchResponse in interface IDirModelRO

See Also:

com.plumtree.portalpages.browsing.directory.GetFolderSearchResponse()

GetFolderViewHelper

public IFolderViewHelper GetFolderViewHelper()

Description copied from interface: IFolderModelRO

Retrieves the folder view helper. This contains a method to implement display for one folder. FolderViewHelper is the implementation for general use, but you may need to implement your own helper.

Specified by:

GetFolderViewHelper in interface IFolderModelRO

See Also:

IFolderModelRO.GetFolderViewHelper()

GetHeaderCount

public int GetHeaderCount()

Description copied from interface: IObjectModelRO

Gets the count of the object headers. Returns 0 if the array is null.

Specified by:

GetHeaderCount in interface IObjectModelRO

Returns:

int nHeaderCount

See Also:

IObjectModelRO.GetHeaderCount()

GetHeaderHasCheckbox

public boolean GetHeaderHasCheckbox()

Description copied from interface: IObjectModelRO

Returns whether the header has a checkbox or not.

Specified by:

GetHeaderHasCheckbox in interface IObjectModelRO

Returns:

boolean

See Also:

IObjectModelRO.GetHeaderHasCheckbox()

GetHeaderRow

public HTMLTableRow GetHeaderRow()

Description copied from interface: IObjectModelRO

Returns the header row

Specified by:

GetHeaderRow in interface IObjectModelRO

Returns:

int nHeaderCount

See Also:

IObjectModelRO.GetHeaderRow()

GetHeaderProperties

public IXPList GetHeaderProperties()

Description copied from interface: IDirModelRO

Retrieves the headers to be displayed in a array that includes the header's name, property Id, and sort URL if applicaple.

Specified by:

GetHeaderProperties in interface IDirModelRO

Returns:

GetHeaderText

public java.lang.String GetHeaderText(int nHeaderIndex)

Description copied from interface: IObjectModelRO

Gets the text of the header at the given index.

Specified by:

GetHeaderText in interface IObjectModelRO

Parameters:

nHeaderIndex - nHeaderIndex

Returns:

String strHeaderText

See Also:

IObjectModelRO.GetHeaderText(int)

GetIsCollapsable

public boolean GetIsCollapsable()

Description copied from interface: IObjectModelRO

Gets whether or not the object banner should be collapsable.

Specified by:

GetIsCollapsable in interface IObjectModelRO

Returns:

boolean true implies collapsible.

See Also:

IObjectModelRO.GetIsCollapsable()

GetIsFolderSelected

public boolean GetIsFolderSelected(int nFolderID)

Description copied from interface: IFolderModelRO

This method returns whether or not the requested folder is currently selected.

Specified by:

GetIsFolderSelected in interface IFolderModelRO

Returns:

boolean true implies selected, false implies not selected

See Also:

IFolderModelRO.GetShowCheckbox()

GetIsObjectSelected

public boolean GetIsObjectSelected(int nObjectID)

Description copied from interface: IObjectModelRO

This method returns whether or not the requested object ID is currently selected.

Specified by:

GetIsObjectSelected in interface IObjectModelRO

Returns:

boolean true implies selected, false implies not selected

See Also:

IObjectModelRO.GetIsObjectSelected(int)

GetLastFolderIndex

public int GetLastFolderIndex()

Description copied from interface: IFolderModelRO

Get the index of the first folder to display.

Specified by:

GetLastFolderIndex in interface IFolderModelRO

See Also:

IFolderModelRO.GetLastFolderIndex()

GetMoreFolderID

public int GetMoreFolderID()

Specified by:

GetMoreFolderID in interface IDirModelRO

Returns:

GetMoreRelatedResources

public java.lang.Object[][] GetMoreRelatedResources(int nRelatedResourceID)

Specified by:

GetMoreRelatedResources in interface IDirModelRO

Returns:

GetMoveTargetFolderTREESUBSPACE

public java.lang.String GetMoveTargetFolderTREESUBSPACE()

Specified by:

GetMoveTargetFolderTREESUBSPACE in interface IDirModelRO

Returns:

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class AClearModel

Returns:

the name of the object.

See Also:

com.plumtree.xpshared.activityspace.IModel#GetName()

GetNewTempData

public java.lang.Object GetNewTempData()

Description copied from class: AClearModel

This method returns a new temporary data object. It is called at the beginning of a new HTTP Request. This method can perform initialization on the data object if necessary.

Specified by:

GetNewTempData in class AClearModel

Returns:

GetNumDocsPerPage

public int GetNumDocsPerPage()

Specified by:

GetNumDocsPerPage in interface IDirModelRO

Returns:

SetNumDocsPerPage

public void SetNumDocsPerPage(int _nNumDocsPerPage)

Parameters:

_nNumDocsPerPage - The Number of cards per page to be set.

GetNumFolderColumns

public int GetNumFolderColumns()

Specified by:

GetNumFolderColumns in interface IDirModelRO

Returns:

GetNumObjects

public int GetNumObjects()

See Also:

com.plumtree.portalpages.common.objects.IPaginationModelRO#GetNumObjects()

GetNumSubSubFolders

public int GetNumSubSubFolders()

Specified by:

GetNumSubSubFolders in interface IDirModelRO

Returns:

GetNumSubSubFoldersToDisplay

public int GetNumSubSubFoldersToDisplay()

Description copied from interface: IFolderModelRO

Set the number of sub-subfolders to display after the next page..

Specified by:

GetNumSubSubFoldersToDisplay in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetNumSubSubFolders()

GetObjectBannerText

public java.lang.String GetObjectBannerText()

this creates a string with the banner sub-header text.

Specified by:

GetObjectBannerText in interface IDirModelRO

GetCardRange

public int[] GetCardRange()

Returns an array with 4 int, [0] start of range, [1] end of range, [2] card count, [3] total count

Specified by:

GetCardRange in interface IDirModelRO

GetObjectBannerTitle

public java.lang.String GetObjectBannerTitle()

Description copied from interface: IObjectModelRO

Gets the name of the current folder.

Specified by:

GetObjectBannerTitle in interface IObjectModelRO

Returns:

String strCurrentFolderName

See Also:

IObjectModelRO.GetObjectBannerTitle()

GetObjectColumnCount

public int GetObjectColumnCount()

Description copied from interface: IObjectModelRO

Gets the number of columns of objects

Specified by:

GetObjectColumnCount in interface IObjectModelRO

Returns:

int nColumnCount

See Also:

IObjectModelRO.GetObjectColumnCount()

GetObjectCount

public int GetObjectCount()

Description copied from interface: IObjectModelRO

Gets the count of the objects in the query result.

Specified by:

GetObjectCount in interface IObjectModelRO

Returns:

int nObjectCount

See Also:

IObjectModelRO.GetObjectCount()

GetObjectFields

public java.lang.Object GetObjectFields(int nIndex,
                                        int nPropID)

Description copied from interface: IObjectModelRO

Gets the fields from the query result.

Specified by:

GetObjectFields in interface IObjectModelRO

Parameters:

nIndex - nIndex

nPropID - nPropID

Returns:

Object oFields

See Also:

IObjectModelRO.GetObjectFields(int, int)

GetObjectType

public int GetObjectType()

Description copied from interface: IObjectModelRO

Get the Object Class ID of the type of objects we are currently viewing.

Specified by:

GetObjectType in interface IObjectModelRO

Returns:

int the class ID of the object

See Also:

com.plumtree.portalpages.common.folder.IObjectModelRO#GetObjectType()

GetObjectSubType

public int GetObjectSubType(int nIndex)

Description copied from interface: IObjectModelRO

Get the subtype of the object at the given index.

Specified by:

GetObjectSubType in interface IObjectModelRO

Parameters:

nIndex - index of the object in the list.

Returns:

the subtype of the object, or -1 if the object has no subtype.

See Also:

com.plumtree.portalpages.common.objects.IObjectModelRO#GetObjectSubType()

GetObjectViewIsCollapsed

public boolean GetObjectViewIsCollapsed()

Description copied from interface: IObjectModelRO

Get whether the object view is collapsed. This is only relevant if GetIsCollapsable() returns true.

Specified by:

GetObjectViewIsCollapsed in interface IObjectModelRO

Returns:

bObjectViewIsCollapsed

See Also:

IObjectModelRO.GetObjectViewIsCollapsed()

GetParentDefaultDataSourceIDRecursive

public int GetParentDefaultDataSourceIDRecursive()

Description copied from interface: IDirModelRO

returns the ID of the Default DataSource for this folder. It will recursively search up the ancestors to

Specified by:

GetParentDefaultDataSourceIDRecursive in interface IDirModelRO

Returns:

GetParentFolderID

public int GetParentFolderID()

Description copied from interface: IFolderModelRO

Get the ID of the parent folder of the current folder.

Specified by:

GetParentFolderID in interface IFolderModelRO

See Also:

IFolderModelRO.GetParentFolderID()

OpenFolderByPath

public int OpenFolderByPath(java.lang.String strPath)

Specified by:

OpenFolderByPath in interface IDirModel

GetParentFolderIDs

public java.lang.Object[] GetParentFolderIDs()

Description copied from interface: IFolderModelRO

Get an Object array containing the Integer IDs of all the parent folders (the path) of the current folder. Each element in the array must be cast to an Integer. This will return one ID per folder in the path, except for the root folder, where two IDs will be returned even though there is only one folder in the path.

Specified by:

GetParentFolderIDs in interface IFolderModelRO

See Also:

IFolderModelRO.GetParentFolderIDs()

GetBreadCrumbPath

public IASQueryResult GetBreadCrumbPath()

Specified by:

GetBreadCrumbPath in interface IDirModelRO

Returns:

GetPath

public java.lang.String GetPath()

Description copied from interface: IFolderModelRO

Get the path to the current folder concatenated with '\'.

Specified by:

GetPath in interface IFolderModelRO

See Also:

IFolderModelRO.GetPath()

GetPropColumns

public XPArrayList GetPropColumns()

Specified by:

GetPropColumns in interface IDirModelRO

Returns:

GetRRCategory

public int GetRRCategory()

Specified by:

GetRRCategory in interface IDirModelRO

Returns:

GetRRObjectID

public int GetRRObjectID()

Specified by:

GetRRObjectID in interface IDirModelRO

Returns:

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish()

Description copied from interface: IRepostModel

Returns the Redirect object (this is were we need to go at the end of the Editor).

Specified by:

GetRedirectAfterFinish in interface IRepostModel

Returns:

GetRelatedResource

public IASQueryResult GetRelatedResource(int lRelatedResourceID)

Specified by:

GetRelatedResource in interface IDirModelRO

Parameters:

lRelatedResourceID -

Returns:

GetRelatedResourceIDs

public int[] GetRelatedResourceIDs()

Specified by:

GetRelatedResourceIDs in interface IDirModelRO

Returns:

GetRelatedResourceString

public java.lang.String GetRelatedResourceString(int nRelatedResourceID)

Specified by:

GetRelatedResourceString in interface IDirModelRO

Parameters:

nRelatedResourceID -

Returns:

GetRelatedResourcesLocation

public int GetRelatedResourcesLocation()

Specified by:

GetRelatedResourcesLocation in interface IDirModelRO

Returns:

GetSession

public IPTSession GetSession()

Specified by:

GetSession in interface IDirModelRO

Returns:

GetShowCheckbox

public boolean GetShowCheckbox()

Description copied from interface: IFolderModelRO

Returns whether the folders should have checkboxes next to them.

Specified by:

GetShowCheckbox in interface IFolderModelRO

See Also:

IFolderModelRO.GetShowCheckbox()

GetShowFolderBanner

public boolean GetShowFolderBanner()

Description copied from interface: IFolderModelRO

Returns whether the subfolder banner should be shown.

Specified by:

GetShowFolderBanner in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetShowBanner()

GetShowPagination

public boolean GetShowPagination()

Description copied from interface: IObjectModelRO

Get whether these objects should use pagination or not. If this is true, the header will have a pagination bar. If this is true, the AActivitySpace will need to include the pagination framework (pass-thru repost control & implement pagination model interface).

Specified by:

GetShowPagination in interface IObjectModelRO

Returns:

boolean true implies show pagination bar

See Also:

IObjectModelRO.GetShowPagination()

GetSortDirection

public int GetSortDirection()

Description copied from interface: ISortModelRO

Get the sort direction for the currently sorted header column. This should return either PTSortedArrayWrapper.PTSAW_SORT_ASCENDING or PTSortedArrayWrapper.PTSAW_SORT_DESCENDING. This method only needs to return useful information if GetSortable() returns true.

Specified by:

GetSortDirection in interface ISortModelRO

Returns:

int the sort direction from PTSortedArrayWrapper.

See Also:

com.plumtree.portalpages.common.objects.ISortModelRO#GetSortDirection()

GetSortable

public boolean GetSortable()

Description copied from interface: IObjectModelRO

Get whether these objects are sortable or not. If this is true, the headers will be sortable. If this is true, the AActivitySpace will need to include the sortable framework (pass-thru repost control & implement sortable model interface).

Specified by:

GetSortable in interface IObjectModelRO

Returns:

boolean true implies sortable

See Also:

IObjectModelRO.GetSortable()

GetSortedHeader

public int GetSortedHeader()

Description copied from interface: ISortModelRO

Get the column id of the header that is currently sorted (starting with 0). This method only needs to return useful information if GetSortable() returns true.

Specified by:

GetSortedHeader in interface ISortModelRO

Returns:

int the column id of the currently sorted header column.

See Also:

com.plumtree.portalpages.common.objects.ISortModelRO#GetSortedHeader()

GetSpaceID

public java.lang.String GetSpaceID()

Get the SpaceID of the parent Activity Space

Specified by:

GetSpaceID in interface IObjectModelRO

Returns:

int m_asOwner.GetSpaceID();

GetSubFolderCount

public int GetSubFolderCount()

Description copied from interface: IFolderModelRO

Get the number of folders at all levels in the hierachy

Specified by:

GetSubFolderCount in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderCount()

GetSubFolderCount

public int GetSubFolderCount(int nLevel)

Description copied from interface: IFolderModelRO

Get the number of sub folders in the current folder at the specified level.

Specified by:

GetSubFolderCount in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderCount()

GetTotalResults

public int GetTotalResults()

Specified by:

GetTotalResults in interface IDirModelRO

Returns:

HasAccessToEditCard

public boolean HasAccessToEditCard()

Specified by:

HasAccessToEditCard in interface IDirModelRO

Returns:

HasAccessToEditFolder

public boolean HasAccessToEditFolder()

Specified by:

HasAccessToEditFolder in interface IDirModelRO

Returns:

HasAccessToApproveCardInFolder

public boolean HasAccessToApproveCardInFolder()

Specified by:

HasAccessToApproveCardInFolder in interface IDirModelRO

Returns:

HasSelfSelectExpertRightOnThisFolder

public boolean HasSelfSelectExpertRightOnThisFolder()

Specified by:

HasSelfSelectExpertRightOnThisFolder in interface IDirModelRO

Returns:

GetSubPortalAccessType

public int GetSubPortalAccessType()

Specified by:

GetSubPortalAccessType in interface IDirModelRO

Returns:

InRootFolder

public boolean InRootFolder()

Description copied from interface: IFolderModelRO

Returns true if the current folder is the root folder.

Specified by:

InRootFolder in interface IFolderModelRO

See Also:

IFolderModelRO.InRootFolder()

InUnclassifiedCardsFolder

public boolean InUnclassifiedCardsFolder()

Specified by:

InUnclassifiedCardsFolder in interface IDirModelRO

Returns:

Init

public void Init(AActivitySpace parent)

Description copied from interface: IModel

This method initializes the model. This is called automatically when AActivitySpace.RegisterModel() is called.

Specified by:

Init in interface IModel

Overrides:

Init in class AClearModel

Parameters:

parent - the parent Activity Space

See Also:

com.plumtree.xpshared.activityspace.IModel#Init()

LoadBrowsingPropColumns

public void LoadBrowsingPropColumns()

IsAtMaxFolderLevel

public boolean IsAtMaxFolderLevel()

Description copied from interface: IDirModelRO

This method returns whether or not the current folder is at the max level

Specified by:

IsAtMaxFolderLevel in interface IDirModelRO

Returns:

IsRelatedExpert

public boolean IsRelatedExpert()

Specified by:

IsRelatedExpert in interface IDirModelRO

Returns:

IsWebDataSource

public boolean IsWebDataSource(int nDataSourceID)

Check if the provider for this data source supports web paths.

Specified by:

IsWebDataSource in interface IDirModelRO

Parameters:

nDataSourceID - the data source to check

Returns:

whether or not the provider for this data source supports web paths.

LoadCardProperties

public void LoadCardProperties()

LoadFoldersAndDocuments

public boolean LoadFoldersAndDocuments()

LoadNewAndUpdatedDates

public void LoadNewAndUpdatedDates()

GetObjectNewTagDate

public XPDateTime GetObjectNewTagDate()

Specified by:

GetObjectNewTagDate in interface IDirModelRO

Returns:

GetObjectUpdateTagDate

public XPDateTime GetObjectUpdateTagDate()

Specified by:

GetObjectUpdateTagDate in interface IDirModelRO

Returns:

LoadUserPrefs

public void LoadUserPrefs()

GetUserPrefOpenDocInNewWindow

public boolean GetUserPrefOpenDocInNewWindow()

Specified by:

GetUserPrefOpenDocInNewWindow in interface IDirModelRO

Returns:

GetUserPrefLocale

public XPLocale GetUserPrefLocale()

Specified by:

GetUserPrefLocale in interface IDirModelRO

Returns:

GetUserPrefTimeZone

public XPTimeZone GetUserPrefTimeZone()

Specified by:

GetUserPrefTimeZone in interface IDirModelRO

Returns:

MoveCards

public void MoveCards(int[] arCardIDs,
                      int nTargetFolder)

Specified by:

MoveCards in interface IDirModel

MoveFolders

public void MoveFolders(int[] arFolderIDs,
                        int nTargetFolder)

Specified by:

MoveFolders in interface IDirModel

OpenSubFolder

public void OpenSubFolder(int ID)

Description copied from interface: IFolderModel

Open the folder with the id ID. This method should change the model to contain data for the new folder.

Specified by:

OpenSubFolder in interface IDirModel

Specified by:

OpenSubFolder in interface IFolderModel

See Also:

IFolderModel.OpenSubFolder(int)

RefreshItemFromCopyTargetFolderTree

public int RefreshItemFromCopyTargetFolderTree()

This method gets the selected items from the tree.

Specified by:

RefreshItemFromCopyTargetFolderTree in interface IDirModelRO

RefreshItemFromDataSourceTree

public int RefreshItemFromDataSourceTree()

This method gets the selected items from the tree.

Specified by:

RefreshItemFromDataSourceTree in interface IDirModelRO

RefreshItemFromMoveTargetFolderTree

public int RefreshItemFromMoveTargetFolderTree()

This method gets the selected items from the tree.

Specified by:

RefreshItemFromMoveTargetFolderTree in interface IDirModelRO

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Description copied from interface: IRepostModel

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Returns:

int Page status for server side validation

See Also:

IRepostModel.SavePage(String, XPHashtable)

SetCardSubmitMode

public void SetCardSubmitMode(int nCardID)

Specified by:

SetCardSubmitMode in interface IDirModel

GetCardSubmitMode

public int GetCardSubmitMode()

Specified by:

GetCardSubmitMode in interface IDirModelRO

Returns:

SetCardID

public void SetCardID(int nCardID)

Specified by:

SetCardID in interface IDirModel

ClearCardRange

public void ClearCardRange()

Specified by:

ClearCardRange in interface IDirModel

SetCardRange

public void SetCardRange(int nRangeBegin,
                         int nRangeEnd)

Specified by:

SetCardRange in interface IDirModel

SetCardSubmitDataSource

public void SetCardSubmitDataSource(int nDataSourceID)

Specified by:

SetCardSubmitDataSource in interface IDirModel

SetCardSubmitURL

public void SetCardSubmitURL(java.lang.String strURL)

Specified by:

SetCardSubmitURL in interface IDirModel

SetDocUploadParams

public void SetDocUploadParams(java.lang.String _duID,
                               java.lang.String _duServer)

Specified by:

SetDocUploadParams in interface IDirModel

SetCardSubmitName

public void SetCardSubmitName(java.lang.String strName)

Specified by:

SetCardSubmitName in interface IDirModel

SetCardSubmitDescription

public void SetCardSubmitDescription(java.lang.String strDescription)

Specified by:

SetCardSubmitDescription in interface IDirModel

SetCardSubmitFolder

public void SetCardSubmitFolder(int _nFolderID)

Description copied from interface: IDirModel

Set the folder to use when submitting a document. If this is not set, the current folder will be used.

Specified by:

SetCardSubmitFolder in interface IDirModel

GetCardSubmitFolder

public int GetCardSubmitFolder()

Specified by:

GetCardSubmitFolder in interface IDirModelRO

Returns:

the folder the card was submitted into (either the current folder, or the card submit override folder).

SetCardSubmitError

public void SetCardSubmitError(int _nErrorCode)

Description copied from interface: IDirModel

Sets the error associated with the card submit.

Specified by:

SetCardSubmitError in interface IDirModel

Parameters:

_nErrorCode - The error generated during card submission. -1 means no error, and is the default value.

SetDefaultCardRefreshSettings

public void SetDefaultCardRefreshSettings(int nCardID)

Specified by:

SetDefaultCardRefreshSettings in interface IDirModel

SetDirectoryMode

public void SetDirectoryMode(int nMode)

Description copied from interface: IDirModel

Sets the Directory mode - Browse or Edit.

Specified by:

SetDirectoryMode in interface IDirModel

SetFirstItemIndex

public void SetFirstItemIndex(int nFirstItemIndex)

Description copied from interface: IFolderModel

Set the index of the first folder to display on a page.

Specified by:

SetFirstItemIndex in interface IFolderModel

See Also:

IFolderModel.SetFirstItemIndex(int)

SetFolderIDAndMode

public void SetFolderIDAndMode(int ID,
                               int nMode)

Opens the requested subfolder and sets the mode as appropriate.

SetFoldersForDeleteCheck

public void SetFoldersForDeleteCheck(boolean bFolders)

Parameters:

bFolders -

SetLastItemIndex

public void SetLastItemIndex(int nLastItemIndex)

Description copied from interface: IFolderModel

Set the index of the first folder to display on a page.

Specified by:

SetLastItemIndex in interface IFolderModel

See Also:

IFolderModel.SetLastItemIndex(int)

SetMoreFolderID

public void SetMoreFolderID(int nFolderID)

Parameters:

nFolderID -

SetNumColumns

public void SetNumColumns(int nNumColumns)

See Also:

com.plumtree.portalpages.common.folder.IFolderModel#SetNumColumns(int)

SetObjectType

public void SetObjectType(int nNewObjectType)

Description copied from interface: IDirModel

This activity space holds only cards, so no need to change the type.

Specified by:

SetObjectType in interface IDirModel

SetRRCategory

public void SetRRCategory(int nCategoryID)

Parameters:

nCategoryID -

SetRRObjectID

public void SetRRObjectID(int nObjectID)

Parameters:

nObjectID -

SetSortByPropID

public void SetSortByPropID(int nSortByPropID)

Parameters:

nSortByPropID -

ShowFolderActionBanner

public boolean ShowFolderActionBanner()

Specified by:

ShowFolderActionBanner in interface IDirModelRO

Returns:

ShowObjectBanner

public boolean ShowObjectBanner()

Description copied from interface: IObjectModelRO

Get whether to show the banner or not.

Specified by:

ShowObjectBanner in interface IObjectModelRO

Returns:

boolean true implies show banner

See Also:

IObjectModelRO.ShowObjectBanner()

ShowRelatedResources

public boolean ShowRelatedResources()

Specified by:

ShowRelatedResources in interface IDirModelRO

Returns:

IsValidSimpleSubmitSource

public boolean IsValidSimpleSubmitSource(int _nDataSourceID)

Specified by:

IsValidSimpleSubmitSource in interface IDirModelRO

Returns:

boolean true if the specified data source is valid for simple submit (i.e. web, or remote document upload).

SupportsUpload

public boolean SupportsUpload(int _nDataSourceID)

Returns true if the specified data source supports remote document upload.

Specified by:

SupportsUpload in interface IDirModelRO

Returns:

boolean

GetWebServiceID

public int GetWebServiceID(int _nDataSourceID)

GetWarning

public SearchExecutionWarning GetWarning()

Description copied from interface: IDirModelRO

return a warning from the last search query(used in browse by search)

Specified by:

GetWarning in interface IDirModelRO

See Also:

com.plumtree.portalpages.search.IBaseSearchResultModelRO.GetWarning()

GetUploadWSURL

public java.lang.String GetUploadWSURL(int _nDataSourceID)

Returns the webservice's upload url if it supports uploads and it is set.

Specified by:

GetUploadWSURL in interface IDirModelRO

Returns:

String

SubmitCard

public void SubmitCard()

Specified by:

SubmitCard in interface IDirModel

SubmitCard

public void SubmitCard(java.lang.String _strPath,
                       int _nCSSelectedDataSource)

Specified by:

SubmitCard in interface IDirModel

SubmitCard

public void SubmitCard(java.lang.String _path,
                       java.lang.String _type,
                       java.lang.String _docID)

Specified by:

SubmitCard in interface IDirModel

CreateCardSubmitUploadPropertyBag

public IXPPropertyBag CreateCardSubmitUploadPropertyBag(java.lang.String _path,
                                                        java.lang.String _type,
                                                        java.lang.String _docID)

SubmitCardWithPropertyBag

public void SubmitCardWithPropertyBag(int nDataSourceID,
                                      java.lang.String strCardName,
                                      java.lang.String strCardDescription,
                                      IXPPropertyBag pbagCardProp,
                                      int nFolderID)

Specified by:

SubmitCardWithPropertyBag in interface IDirModel

nFolderID - the folder to use. If this is -1, the current folder will be used.

SubmitCardWithPropertyBag

public void SubmitCardWithPropertyBag(int[] arFolderIDs,
                                      java.lang.String strLanguage,
                                      int nDocTypeID,
                                      int nDataSourceID,
                                      IXPPropertyBag pbagCardProp,
                                      java.lang.String strCardName,
                                      java.lang.String strCardDescription)

Specified by:

SubmitCardWithPropertyBag in interface IDirModel

doApproval

public void doApproval(int[] arCardIDs,
                       int nAction)

Specified by:

doApproval in interface IDirModel

doesPropertyDescribeCard

public boolean doesPropertyDescribeCard(java.lang.Object[] arCardPropIDs,
                                        int nPropID)

Parameters:

arCardPropIDs -

nPropID -

Returns:

GetObjectTags

public IXPList GetObjectTags(int docId)

Description copied from interface: ITaggingModel

Gets the List of Tags of that are attached to this Object by pathways.

Specified by:

GetObjectTags in interface ITaggingModel

Parameters:

docId - Object Id

Returns:

List of Tags added to This Object

RetrieveSubFoldersThroughSearch

public boolean RetrieveSubFoldersThroughSearch()

Description copied from interface: IDirModelRO

This method returns whether or not subfolders queries are performed through search

Specified by:

RetrieveSubFoldersThroughSearch in interface IDirModelRO

Returns:

boolean

SearchSubFolders

public IPTSearchResponse SearchSubFolders(int nFolderID,
                                          int nCurrentLevel)

Specified by:

SearchSubFolders in interface IDirModel

CreateSubFolderSearchFilter

public IPTFilter CreateSubFolderSearchFilter(int nCurrentLevel)

GetFolderSearchMapping

public int GetFolderSearchMapping(int nIndex)

Description copied from interface: IDirModelRO

Retrieves the index within the SearchResponse that corresponds to the ordering that would have been returned from IPTCatalog.QuerySubfolders()

Specified by:

GetFolderSearchMapping in interface IDirModelRO

CalculateReportMapping

public int[] CalculateReportMapping(IPTSearchResponse ptSR,
                                    int nCurrentLevel)

Generates a mapping to an array that mimics what is returned by IPTFolder.QuerySubFolders()

IsDateProperty

public boolean IsDateProperty(int nPropertyID)

Parameters:

strURL -

Returns:

GetCustomFields

public XPArrayList GetCustomFields(int _nObjectIndex,
                                   XPArrayList xpCustomProps,
                                   XPLocale xpLocale,
                                   XPTimeZone xpTimeZone)

Description copied from interface: IDirModelRO

Returns an array list of the values for each custom property in xpCustomProps for the document in index _nObjectIndex.

Specified by:

GetCustomFields in interface IDirModelRO

Parameters:

_nObjectIndex -

xpCustomProps -

Returns:

SetSaveTempData

public void SetSaveTempData(boolean _saveTempData)

Parameters:

saveURL - The m_bCSSaveURL to set.

GetDocumentTypeId

public int GetDocumentTypeId()

Specified by:

GetDocumentTypeId in interface IDirModelRO

Returns:

SetDocumentTypeId

public void SetDocumentTypeId(java.lang.String documentTypeId)

Specified by:

SetDocumentTypeId in interface IDirModel

AddRemoveObjectTag

public void AddRemoveObjectTag(java.lang.String tagname,
                               java.lang.String strid,
                               int action,
                               java.lang.String ptsource)
                        throws XPIllegalStateException

Description copied from interface: ITaggingModel

Adds/Removes Tag specified for the Object with given ID based on Action specified.

Specified by:

AddRemoveObjectTag in interface ITaggingModel

Parameters:

tagname - Name of the Tag that needs to be Added or Removed

strid - Concatenation of classid and Object Id PTCLASSID_PTOJECTID

action - Operation to perform on the Tag, 0 = Add, 1 = Delete, 2 = Edit (delete old tag and add new tag)

ptsource - source of the Object to be specified for Pathways it can be PTPORTAL or PTCOLLAB, for more sources see PathwaysConstants.

Throws:

XPIllegalStateException - Throws this exception if pathways is unavailable and a request to Add/Remove Tags is sent.

RenameObjectTag

public void RenameObjectTag(java.lang.String tagname,
                            java.lang.String strid,
                            java.lang.String ptsource,
                            java.lang.String renametag)
                     throws XPIllegalStateException

Description copied from interface: ITaggingModel

Renames Tag specified for the Object with given ID.

Specified by:

RenameObjectTag in interface ITaggingModel

Parameters:

tagname - the Source Tag Name to be used for renaming

strid - Concatenation of classid and Object Id PTCLASSID_PTOJECTID

ptsource - source of the Object to be specified for Pathways it can be PTPORTAL or PTCOLLAB, for more sources see PathwaysConstants.

Throws:

XPIllegalStateException - Throws this exception if pathways is unavailable and a request to Add/Remove Tags is sent.

IsTaggingEnabled

public boolean IsTaggingEnabled()

Description copied from interface: ITaggingModel

True if Pathways is enabled and user can tag items, else false.

Specified by:

IsTaggingEnabled in interface ITaggingModel

Returns:

boolean

GetPathwaysTaggingError

public XPException GetPathwaysTaggingError()

Description copied from interface: ITaggingModel

This method returns an error that happened when Add/Remove/Rename Tag request is sent to pathways. This returns null if there is no error.

Specified by:

GetPathwaysTaggingError in interface ITaggingModel

Returns:

XPException that contains the error, if Tagging was success then it returns null.

SetPathwaysTaggingError

public void SetPathwaysTaggingError(XPException e)

Description copied from interface: ITaggingModel

This method sets error that happened when tagging request is sent to pathways.

Specified by:

SetPathwaysTaggingError in interface ITaggingModel