com.plumtree.portalpages.browsing.directory
Interface IDirModel

All Superinterfaces:

IDirModelRO, IFolderModel, IFolderModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IObjectModelRO

All Known Implementing Classes:

DirModel

public interface IDirModel
extends IDirModelRO

This interface contains the methods on the DirModel that make changes. IDirModelRO contains the read-only methods.

Method Summary

void	ABODeleteFolders(int[] arFolderIDs)
void	ClearCardRange()
void	CopyCards(int[] arCardIDs, int nTargetFolder)
void	CopyFolders(int[] arFolderIDs, int nTargetFolder)
void	CreateDirectoryFolder(java.lang.String strName, java.lang.String strDescription) Creates a Directory Folder and calls the PEIs OnBeforeCreateDirectoryFolder and OnAfterCreateDirectoryFolder.
void	DeleteCards(int[] arCardIDs)
void	DeleteFolders(int[] arFolderIDs)
void	doApproval(int[] arCardIDs, int nAction)
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.
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	SetObjectType(int nNewObjectType) This activity space holds only cards, so no need to change the type.
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)

Methods inherited from interface com.plumtree.portalpages.browsing.directory.IDirModelRO

ABOJobIDsToDisplay, CheckFoldersForDelete, CheckForActivityRight, GetABOJobIDs, GetBasicCardProperties, GetBreadCrumbPath, GetBrowseBy, GetBrowseBySource, GetCardID, GetCardInformation, GetCardName, GetCardName, GetCardRange, GetCardRangeBegin, GetCardSubmitDataSource, GetCardSubmitError, GetCardSubmitFolder, GetCardSubmitMode, GetCardSubmitURL, GetClassID, GetCopyTargetFolderTREESUBSPACE, GetCreatedFolderID, GetCustomCardProperties, GetCustomFields, GetDataSourceName, GetDataSourceTREESUBSPACE, GetDirectoryMode, GetDocDescriptionType, GetDocumentTypeId, GetFilteredDataSources, GetFolderDescriptionType, GetFolderName, GetFolderPath, GetFolderSearchMapping, GetFolderSearchResponse, GetHeaderProperties, GetMoreFolderID, GetMoreRelatedResources, GetMoveTargetFolderTREESUBSPACE, GetNumDocsPerPage, GetNumFolderColumns, GetNumSubSubFolders, GetObjectBannerText, GetObjectID, GetObjectNewTagDate, GetObjectUpdateTagDate, GetObjectUUID, GetParentDefaultDataSourceIDRecursive, GetPropColumns, GetRelatedResource, GetRelatedResourceIDs, GetRelatedResourcesLocation, GetRelatedResourceString, GetRRCategory, GetRRObjectID, GetSession, GetSubPortalAccessType, GetTotalResults, GetUploadWSURL, GetUserPrefLocale, GetUserPrefOpenDocInNewWindow, GetUserPrefTimeZone, GetWarning, HasAccessToApproveCardInFolder, HasAccessToEditCard, HasAccessToEditFolder, HasSelfSelectExpertRightOnThisFolder, InUnclassifiedCardsFolder, IsAtMaxFolderLevel, IsRelatedExpert, IsValidSimpleSubmitSource, IsWebDataSource, RefreshItemFromCopyTargetFolderTree, RefreshItemFromDataSourceTree, RefreshItemFromMoveTargetFolderTree, RetrieveSubFoldersThroughSearch, ShowFolderActionBanner, ShowRelatedResources, SupportsUpload

Methods inherited from interface com.plumtree.portalpages.common.folder.IFolderModel

SetFirstItemIndex, SetLastItemIndex

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel

CleanupAllData, CleanupTempData, Init

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IManagedObject

Create

Methods inherited from interface com.plumtree.portalpages.common.folder.IFolderModelRO

GetCurrentFolderID, GetCurrentFolderLevel, GetCurrentFolderName, GetFirstFolderIndex, GetFolderColumnCount, GetFolderObjectCount, GetFolderQueryResult, GetFolderViewHelper, GetIsFolderSelected, GetLastFolderIndex, GetNumSubSubFoldersToDisplay, GetParentFolderID, GetParentFolderIDs, GetPath, GetShowCheckbox, GetShowFolderBanner, GetSubFolderCount, GetSubFolderCount, InRootFolder

Methods inherited from interface com.plumtree.portalpages.common.objects.IObjectModelRO

DoNotShowObject, GetDisplayPaginationHiddenInputs, GetDisplaySortHiddenInputs, GetHeaderCount, GetHeaderHasCheckbox, GetHeaderRow, GetHeaderText, GetIsCollapsable, GetIsObjectSelected, GetObjectBannerTitle, GetObjectColumnCount, GetObjectCount, GetObjectFields, GetObjectSubType, GetObjectType, GetObjectViewIsCollapsed, GetShowPagination, GetSortable, GetSpaceID, ShowObjectBanner

Method Detail

ABODeleteFolders

void ABODeleteFolders(int[] arFolderIDs)

Parameters:

arFolderIDs -

CopyCards

void CopyCards(int[] arCardIDs,
               int nTargetFolder)

Parameters:

arCardIDs -

nTargetFolder -

CopyFolders

void CopyFolders(int[] arFolderIDs,
                 int nTargetFolder)

Parameters:

arFolderIDs -

nTargetFolder -

CreateDirectoryFolder

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

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

Parameters:

strName - Folder Name

strDescription - Folder Description

DeleteCards

void DeleteCards(int[] arCardIDs)

Parameters:

arCardIDs -

DeleteFolders

void DeleteFolders(int[] arFolderIDs)

Parameters:

arFolderIDs -

MigrateObjects

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

This method adds objects into the migration queue.

OpenFolderByPath

int OpenFolderByPath(java.lang.String strPath)

MoveCards

void MoveCards(int[] arCardIDs,
               int nTargetFolder)

Parameters:

arCardIDs -

nTargetFolder -

MoveFolders

void MoveFolders(int[] arFolderIDs,
                 int nTargetFolder)

Parameters:

arFolderIDs -

nTargetFolder -

OpenSubFolder

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 IFolderModel

See Also:

IFolderModel.OpenSubFolder(int)

SetCardSubmitMode

void SetCardSubmitMode(int nCardID)

SetCardID

void SetCardID(int nCardID)

ClearCardRange

void ClearCardRange()

SetCardRange

void SetCardRange(int nRangeBegin,
                  int nRangeEnd)

Parameters:

nRangeBegin -

nRangeEnd -

SetCardSubmitDataSource

void SetCardSubmitDataSource(int nDataSourceID)

Parameters:

nDataSourceID -

SetCardSubmitURL

void SetCardSubmitURL(java.lang.String strURL)

Parameters:

strURL -

SetDocUploadParams

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

SetCardSubmitName

void SetCardSubmitName(java.lang.String strName)

Parameters:

strURL -

SetCardSubmitDescription

void SetCardSubmitDescription(java.lang.String strDescription)

Parameters:

strURL -

SetCardSubmitFolder

void SetCardSubmitFolder(int _nFolderID)

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

Parameters:

_nFolderID -

SetCardSubmitError

void SetCardSubmitError(int _nErrorCode)

Sets the error associated with the card submit.

Parameters:

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

SetDefaultCardRefreshSettings

void SetDefaultCardRefreshSettings(int nCardID)

Parameters:

nCardID -

SetDirectoryMode

void SetDirectoryMode(int nMode)

Sets the Directory mode - Browse or Edit.

Parameters:

int - Directory mode constant

SetObjectType

void SetObjectType(int nNewObjectType)

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

Parameters:

ID - not used

SubmitCard

void SubmitCard()

SubmitCard

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

SubmitCard

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

SubmitCardWithPropertyBag

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

Parameters:

strPath -

nDataSourceID -

strCardName -

strCardDescription -

pbagCardProp -

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

Throws:

java.lang.Exception

SubmitCardWithPropertyBag

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

Parameters:

arFolderIDs -

strLanguage -

nDocTypeID -

nDataSourceID -

pbagCardProp -

strCardName -

strCardDescription -

Throws:

java.lang.Exception

XPException

doApproval

void doApproval(int[] arCardIDs,
                int nAction)

Parameters:

arCardIDs -

nAction -

SearchSubFolders

IPTSearchResponse SearchSubFolders(int nFolderID,
                                   int nCurrentLevel)

SetDocumentTypeId

void SetDocumentTypeId(java.lang.String documentTypeId)