WebCenter Interaction API  
 

IPTAdminFolder Members

IPTAdminFolder overview

Public Instance Methods

public methodGetAdminCatalog Returns the Admin Catalog
public methodGetDefaultOrderBy Returns the default order by as a 1x2 array. The first element is the prop id to order by. The second element is whether it's ascending or descending.
public methodGetFolderLevel Returns the folder level (the number of ancestor folders)
public methodGetFolderType Returns the folder type.
public methodGetJobType Returns the job type associated with this folder
public methodGetParentFolderID Returns the ID of the folder containing this folder, or 0 if no parent
public methodGetParentIDs Returns the IDs of folders that contain this folder as an array
public methodGetPath Returns the path to this admin folder as a string. NOT LOCALIZED. Should call GetPathAsQueryResult instead.
public methodGetPathAsQueryResult Returns path as query result, which includes PT_PROPID_OBJECTID and PT_PROPID_NAME. Then name is correctly localized.
public methodQueryObjects Queries objects that are in this folder based on class ids. Queries can be either secure (only returns objects the current user has access to), or insecure. The resulting IPTQueryResult will have 2 pieces of information: PT_PROPID_CLASS and PT_PROPID_OBJECTID.
public methodQueryObjectsCount Returns the type of objects that are in this folder along with the count of how many each is. The result is returned in a query result with prop ids PT_PROPID_CLASSID and PT_PROPID_OBJECTCOUNT.
public methodQuerySubfoldersOverloaded. Queries the subfolders. This can be immediate (depth 0 or child depth 1).
public methodQuerySubfoldersCount Returns the number of immediate subfolders
public methodSetDefaultOrderBy Sets the default order by. Takes in a 1x2 array The first element is the prop id to order by. The second element is whether it's ascending or descending.
public methodSetFolderType Sets the folder type.
public methodSetJobType Sets the job type of the folder

See Also

IPTAdminFolder Interface | com.plumtree.server Namespace | IPTAdminCatalog