com.plumtree.server
Interface IPTFolder

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTFolder
extends IPTObject

Version:
$Revision$
Author:
Stephen Chang

Method Summary
 void AddClassificationFilter(int lFilterID)
          Assigns a Classification Filter to this Folder
 void AddUserAsRelatedExpert()
          Adds the current user as a Related Expert on this Folder.
 IPTCatalog GetCatalog()
          Returns an interface to the Catalog
 int GetClassificationFiltersOperator()
          Returns the Classification Filter operator, either PT_BOOLOP_AND or PT_BOOLOP_OR, that us applied to the Filters assigned to this Folder
 int GetDefaultDataSource()
          Returns the default DataSource to be used when submitting Cards to this Folder
 int GetDefaultOrderBy()
          Returns the PropertyID by which cards should be ordered when querying through the database
 int GetDefaultSearchOrderBy()
          Returns the PropertyID by which cards should be ordered when querying through search
 int GetFolderLevel()
          Returns the depth of the Folder
 int GetParentFolderID()
          Returns the parent folderID of this Folder
 java.lang.String GetPath()
          Returns the Folder Path starting from root folder to this Folder.
 IPTQueryResult GetPathAsQueryResult()
          Returns a localized path as a query result.
 java.lang.String GetPresentationHint()
          Retrieves the Presentation Hint
 java.lang.Object[] GetRelatedResources(int vsaRelatedResourceIDs)
          Returns the Related Resources assigned to this Folder for the specified categories.
 java.lang.Object[] GetRelatedResources(int[] vsaRelatedResourceIDs)
          Returns the Related Resources assigned to this Folder for the specified categories.
 int GetSettings(int lSettingID)
          Returns a particular setting of this folder.
 int GetSubmitAccessLevel()
          Returns the highest Access Level that the current user has on this Folder
 IPTQueryResult QueryCards(int lPropIDMask, boolean bIncludeUnapproved, int vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries the Cards in this Folder.
 IPTQueryResult QueryCards(int lPropIDMask, boolean bIncludeUnapproved, java.lang.Object vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries the Cards in this Folder.
 int QueryCardsCount(boolean bIncludeUnapproved)
          Returns the number of cards in this Folder.
 IPTQueryResult QueryClassificationFilters()
          Queries the Filters that are assigned to this Folder
 IPTQueryResult QuerySubfolders(int lPropIDMask, int lDepth, int vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries the subfolders of this folder.
 IPTQueryResult QuerySubfolders(int lPropIDMask, int lDepth, java.lang.Object vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries the subfolders of this folder.
 int QuerySubfoldersCount()
          Returns the number of subfolders directly under this Folder
 void RemoveClassificationFilter(int lFilterID)
          Unassigns a Classification Filter from this Folder.
 int ScheduleRecursiveAction(int ActionType)
          This method is currently not implemented.
 void SetClassificationFiltersOperator(int Value)
          Sets the Classification Filter operator, either PT_BOOLOP_AND or PT_BOOLOP_OR, that is applied to the Filters assigned to this Folder
 void SetDefaultOrderBy(int Value)
          Sets the PropertyID by which cards should be ordered when querying through the database
 void SetDefaultSearchOrderBy(int Value)
          Sets the PropertyID by which cards should be ordered when querying through search
 void SetPresentationHint(java.lang.String Value)
          Sets the Presentation Hint
 void SetSettings(int Value, java.lang.Object pvValue)
          Sets a particular setting value on this folder
 IPTQueryResult SimpleQueryCards(int vOrderBy, java.lang.Object[][] vQueryFilter)
          Queries the Cards of this Folder.
 IPTQueryResult SimpleQueryCards(java.lang.Object vOrderBy, java.lang.Object[][] vQueryFilter)
          Queries the Cards of this Folder.
 IPTQueryResult SimpleQuerySubfolders(int vOrderBy, java.lang.Object[][] vQueryFilter)
          Queries the subfolders of this folder.
 IPTQueryResult SimpleQuerySubfolders(java.lang.Object vOrderBy, java.lang.Object[][] vQueryFilter)
          Queries the subfolders of this folder.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

GetSettings

int GetSettings(int lSettingID)
Returns a particular setting of this folder.

Specified by:
GetSettings in interface IPTServerContext
Parameters:
lSettingID - one of PT_FOLDER_SETTINGS
Returns:
int setting value

SetSettings

void SetSettings(int Value,
                 java.lang.Object pvValue)
Sets a particular setting value on this folder

Parameters:
lSettingID - one of PT_FOLDER_SETTINGS
vValue - the setting value to be set

GetClassificationFiltersOperator

int GetClassificationFiltersOperator()
Returns the Classification Filter operator, either PT_BOOLOP_AND or PT_BOOLOP_OR, that us applied to the Filters assigned to this Folder

Returns:
operator either PT_BOOLOP_AND or PT_BOOLOP_OR

SetClassificationFiltersOperator

void SetClassificationFiltersOperator(int Value)
Sets the Classification Filter operator, either PT_BOOLOP_AND or PT_BOOLOP_OR, that is applied to the Filters assigned to this Folder

Parameters:
Value - operator either PT_BOOLOP_AND or PT_BOOLOP_OR

QueryClassificationFilters

IPTQueryResult QueryClassificationFilters()
Queries the Filters that are assigned to this Folder

Returns:
IPTQueryResult containing PT_PROPID_FOLDER_CLASSIFICATIONFILTERID.

AddClassificationFilter

void AddClassificationFilter(int lFilterID)
Assigns a Classification Filter to this Folder

Parameters:
lFilterID - filterID of the Filter

RemoveClassificationFilter

void RemoveClassificationFilter(int lFilterID)
Unassigns a Classification Filter from this Folder. This does not delete the Filter.

Parameters:
lFilterID - filterID of the Filter

GetPresentationHint

java.lang.String GetPresentationHint()
Retrieves the Presentation Hint

Returns:
Presentation Hint

SetPresentationHint

void SetPresentationHint(java.lang.String Value)
Sets the Presentation Hint

Parameters:
Value - Presentation Hint

GetPath

java.lang.String GetPath()
Returns the Folder Path starting from root folder to this Folder.

Returns:
String representation of the Folder Path.

GetFolderLevel

int GetFolderLevel()
Returns the depth of the Folder

Returns:
Folder Depth

GetDefaultOrderBy

int GetDefaultOrderBy()
Returns the PropertyID by which cards should be ordered when querying through the database

Returns:
propertyID by which results should be ordered.

SetDefaultOrderBy

void SetDefaultOrderBy(int Value)
Sets the PropertyID by which cards should be ordered when querying through the database

Parameters:
Value - propertyID by which cards should be ordered.

GetCatalog

IPTCatalog GetCatalog()
Returns an interface to the Catalog

Returns:
IPTCatalog

GetParentFolderID

int GetParentFolderID()
Returns the parent folderID of this Folder

Returns:
parent folderID

GetSubmitAccessLevel

int GetSubmitAccessLevel()
Returns the highest Access Level that the current user has on this Folder

Returns:
Access Level

QuerySubfoldersCount

int QuerySubfoldersCount()
Returns the number of subfolders directly under this Folder

Returns:
Subfolder count

QuerySubfolders

IPTQueryResult QuerySubfolders(int lPropIDMask,
                               int lDepth,
                               int vOrderBy,
                               int lSkipRows,
                               int lMaxRows,
                               java.lang.Object[][] vQueryFilter)
Queries the subfolders of this folder.

Parameters:
lPropIDMask - propids/columns to include in query result
lDepth - 0 for immediate, 1 to include 1-level down
vOrderBy - order by clause
lSkipRows - default(-1)
lMaxRows - default (-1)
vQueryFilter - query filter
Returns:
IPTQueryResult

QuerySubfolders

IPTQueryResult QuerySubfolders(int lPropIDMask,
                               int lDepth,
                               java.lang.Object vOrderBy,
                               int lSkipRows,
                               int lMaxRows,
                               java.lang.Object[][] vQueryFilter)
Queries the subfolders of this folder.

Parameters:
lPropIDMask - propids/columns to include in query result
lDepth - 0 for immediate, 1 to include 1-level down
vOrderBy - order by clause
lSkipRows - default(-1)
lMaxRows - default (-1)
vQueryFilter - query filter
Returns:
IPTQueryResult

SimpleQuerySubfolders

IPTQueryResult SimpleQuerySubfolders(int vOrderBy,
                                     java.lang.Object[][] vQueryFilter)
Queries the subfolders of this folder. By default the query returns all properties and all matching subfoldres

Parameters:
vOrderBy - order by clause
vQueryFilter - query filter
Returns:
IPTQueryResult

SimpleQuerySubfolders

IPTQueryResult SimpleQuerySubfolders(java.lang.Object vOrderBy,
                                     java.lang.Object[][] vQueryFilter)
Queries the subfolders of this folder. By default the query returns all properties and all matching subfoldres

Parameters:
vOrderBy - order by clause
vQueryFilter - query filter
Returns:
IPTQueryResult

QueryCardsCount

int QueryCardsCount(boolean bIncludeUnapproved)
Returns the number of cards in this Folder.

Parameters:
bIncludeUnapproved - include unapproved cards?
Returns:
card count

QueryCards

IPTQueryResult QueryCards(int lPropIDMask,
                          boolean bIncludeUnapproved,
                          int vOrderBy,
                          int lSkipRows,
                          int lMaxRows,
                          java.lang.Object[][] vQueryFilter)
Queries the Cards in this Folder.

Parameters:
lPropIDMask - propids/columns to include in query result
bIncludeUnapproved - include unapproved cards?
vOrderBy - order by clause
lSkipRows - default(-1)
lMaxRows - default (-1)
vQueryFilter - query filter
Returns:
IPTQueryResult

QueryCards

IPTQueryResult QueryCards(int lPropIDMask,
                          boolean bIncludeUnapproved,
                          java.lang.Object vOrderBy,
                          int lSkipRows,
                          int lMaxRows,
                          java.lang.Object[][] vQueryFilter)
Queries the Cards in this Folder.

Parameters:
lPropIDMask - propids/columns to include in query result
bIncludeUnapproved - include unapproved cards?
vOrderBy - order by clause
lSkipRows - default(-1)
lMaxRows - default (-1)
vQueryFilter - query filter
Returns:
IPTQueryResult

SimpleQueryCards

IPTQueryResult SimpleQueryCards(int vOrderBy,
                                java.lang.Object[][] vQueryFilter)
Queries the Cards of this Folder. By default the query returns all properties and all matching cards

Parameters:
vOrderBy - order by clause
vQueryFilter - query filter
Returns:
IPTQueryResult

SimpleQueryCards

IPTQueryResult SimpleQueryCards(java.lang.Object vOrderBy,
                                java.lang.Object[][] vQueryFilter)
Queries the Cards of this Folder. By default the query returns all properties and all matching cards

Parameters:
vOrderBy - order by clause
vQueryFilter - query filter
Returns:
IPTQueryResult

GetRelatedResources

java.lang.Object[] GetRelatedResources(int[] vsaRelatedResourceIDs)
Returns the Related Resources assigned to this Folder for the specified categories.

Parameters:
vsaRelatedResourceIDs - array of Related Resource categories.
Returns:
array of IPTQueryResults, one per category

GetRelatedResources

java.lang.Object[] GetRelatedResources(int vsaRelatedResourceIDs)
Returns the Related Resources assigned to this Folder for the specified categories.

Parameters:
vsaRelatedResourceIDs - the specific Related Resource catagory
Returns:
array of IPTQueryResults, one per category

ScheduleRecursiveAction

int ScheduleRecursiveAction(int ActionType)
This method is currently not implemented.

Parameters:
ActionType - N/A
Returns:
N/A

GetDefaultSearchOrderBy

int GetDefaultSearchOrderBy()
Returns the PropertyID by which cards should be ordered when querying through search

Returns:
propertyID by which results should be ordered.

SetDefaultSearchOrderBy

void SetDefaultSearchOrderBy(int Value)
Sets the PropertyID by which cards should be ordered when querying through search

Parameters:
Value - propertyID by which cards should be ordered.

GetDefaultDataSource

int GetDefaultDataSource()
Returns the default DataSource to be used when submitting Cards to this Folder

Returns:
datasourceID

AddUserAsRelatedExpert

void AddUserAsRelatedExpert()
Adds the current user as a Related Expert on this Folder. The current user must have the PT_ACTIVITY_RIGHT_SELFSELECTING_EXPERTS activity right as well as SELECT rights on the Folder.


GetPathAsQueryResult

IPTQueryResult GetPathAsQueryResult()
Returns a localized path as a query result.

Returns:
IPTQueryResult containing PT_PROPID_FOLDER_LEVEL, PT_PROPID_OBJECTID, and PT_PROPID_NAME


Copyright 2008 Plumtree Software Inc. All Rights Reserved.