|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTFolder
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 |
---|
int GetSettings(int lSettingID)
GetSettings
in interface IPTServerContext
lSettingID
- one of PT_FOLDER_SETTINGS
void SetSettings(int Value, java.lang.Object pvValue)
lSettingID
- one of PT_FOLDER_SETTINGSvValue
- the setting value to be setint GetClassificationFiltersOperator()
void SetClassificationFiltersOperator(int Value)
Value
- operator either PT_BOOLOP_AND or PT_BOOLOP_ORIPTQueryResult QueryClassificationFilters()
void AddClassificationFilter(int lFilterID)
lFilterID
- filterID of the Filtervoid RemoveClassificationFilter(int lFilterID)
lFilterID
- filterID of the Filterjava.lang.String GetPresentationHint()
void SetPresentationHint(java.lang.String Value)
Value
- Presentation Hintjava.lang.String GetPath()
int GetFolderLevel()
int GetDefaultOrderBy()
void SetDefaultOrderBy(int Value)
Value
- propertyID by which cards should be ordered.IPTCatalog GetCatalog()
int GetParentFolderID()
int GetSubmitAccessLevel()
int QuerySubfoldersCount()
IPTQueryResult QuerySubfolders(int lPropIDMask, int lDepth, int vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
lPropIDMask
- propids/columns to include in query resultlDepth
- 0 for immediate, 1 to include 1-level downvOrderBy
- order by clauselSkipRows
- default(-1)lMaxRows
- default (-1)vQueryFilter
- query filter
IPTQueryResult QuerySubfolders(int lPropIDMask, int lDepth, java.lang.Object vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
lPropIDMask
- propids/columns to include in query resultlDepth
- 0 for immediate, 1 to include 1-level downvOrderBy
- order by clauselSkipRows
- default(-1)lMaxRows
- default (-1)vQueryFilter
- query filter
IPTQueryResult SimpleQuerySubfolders(int vOrderBy, java.lang.Object[][] vQueryFilter)
vOrderBy
- order by clausevQueryFilter
- query filter
IPTQueryResult SimpleQuerySubfolders(java.lang.Object vOrderBy, java.lang.Object[][] vQueryFilter)
vOrderBy
- order by clausevQueryFilter
- query filter
int QueryCardsCount(boolean bIncludeUnapproved)
bIncludeUnapproved
- include unapproved cards?
IPTQueryResult QueryCards(int lPropIDMask, boolean bIncludeUnapproved, int vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
lPropIDMask
- propids/columns to include in query resultbIncludeUnapproved
- include unapproved cards?vOrderBy
- order by clauselSkipRows
- default(-1)lMaxRows
- default (-1)vQueryFilter
- query filter
IPTQueryResult QueryCards(int lPropIDMask, boolean bIncludeUnapproved, java.lang.Object vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
lPropIDMask
- propids/columns to include in query resultbIncludeUnapproved
- include unapproved cards?vOrderBy
- order by clauselSkipRows
- default(-1)lMaxRows
- default (-1)vQueryFilter
- query filter
IPTQueryResult SimpleQueryCards(int vOrderBy, java.lang.Object[][] vQueryFilter)
vOrderBy
- order by clausevQueryFilter
- query filter
IPTQueryResult SimpleQueryCards(java.lang.Object vOrderBy, java.lang.Object[][] vQueryFilter)
vOrderBy
- order by clausevQueryFilter
- query filter
java.lang.Object[] GetRelatedResources(int[] vsaRelatedResourceIDs)
vsaRelatedResourceIDs
- array of Related Resource categories.
java.lang.Object[] GetRelatedResources(int vsaRelatedResourceIDs)
vsaRelatedResourceIDs
- the specific Related Resource catagory
int ScheduleRecursiveAction(int ActionType)
ActionType
- N/A
int GetDefaultSearchOrderBy()
void SetDefaultSearchOrderBy(int Value)
Value
- propertyID by which cards should be ordered.int GetDefaultDataSource()
void AddUserAsRelatedExpert()
IPTQueryResult GetPathAsQueryResult()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |