 | Aqualogic Interaction API | ||
com.plumtree.server Namespace | |||
| Aqualogic Interaction API | ||
com.plumtree.server Namespace | |||
Server Interface Documentation
| Class | Description |
|---|---|
| PlumtreeExtensibility | PlumtreeExtensibility.h THIS FILE IS INTENDED AS AN API. DO NOT ADD ANYTHING TO THIS FILE THAT IS INTERNAL TO THE PLUMTREE SERVER OR EXTENSIBILITY COMPONENTS. This file contains *only* the constants that are defined by the Plumtree server for the purpose of defining extensibility protocols that Accessors, DataSource Providers, Authentication Providers, Delivery Method Providers, and other providers should adhere to. Additionally, constants are defined in Plumtree.h and Plumtree.tlb. In this file are defined constants for the following extensbility areas: - GENERAL - DATA SOURCE PROVIDER (includes crawler functionality) - FEDERATED SEARCH |
| PortalObjectsFactory | Top-level factory class to create Plumtree Portal Objects. The factory-creatable objects and the IPT* interfaces in the com.plumtree.server package represent the public, supported API. Client apps should only import the com.plumtree.server.* and com.plumtree.openfoundation.util.* package classes. Method signatures and names should be forward-compatible with future product releases. Major releases may introduce some compatibility issues, which will be documented for customers as appropriate. |
| PT_ACCESS_LEVELS | This list contains the available access levels in the Plumtree security model. When defining or viewing an Access Control List, each entry will specify a user or group, and an access level. The access level will be an item in this list. For example, these values can be passed into IPTAccessList.Add. |
| PT_ACCESSOR_CAPABILITIES | A list of optional capabilities that an accessor may support. |
| PT_ACL_IMPORT_CAPABILITIES | A list of optional capabilities that a data source ACL sync provider may support. |
| PT_ACL_IMPORT_COLS | Defines the columns of an array of Access Control Lists. |
| PT_ACL_IMPORT_TYPE | Type of Access Control List. |
| PT_ACLSYNC_ITEMTYPES | ACL Sync Map item types. |
| PT_ACLSYNC_MAPPINGTYPES | ACL Sync mapping types |
| PT_ACTIVITY_RIGHTS | This list includes all of the standard Activity Rights supported by Plumtree. |
| PT_ADMIN_FOLDER_JOB_TYPES | These values are used to set or query the job type for an Admin Folder (through IPTAdminFolder.SetJobType() or IPTAdminFolder.GetJobType().) The job type of an Admin Folder determines what action the Admin Folder will perform when it is scheduled to run as a job. |
| PT_ADMIN_FOLDER_SETTINGS | This list includes all supported Admin Folder settings |
| PT_ADMIN_FOLDER_TYPES | This list includes the identifiers for all Admin Folder types. Admin folders have types, which can be queried through IPTAdminFolder.GetFolderType() and set through IPTAdminFolder.SetFolderType(). |
| PT_ASSOCIATEDCONTENT | A list of predefined pages containing content associated with a portlet or web service. |
| PT_AUDIT_TYPES | This list includes all the types of auditing supported by Plumtree. Note that the auditing types are bitmasked values. The level of auditing is indicated by the value of the indicated bits in the PT_SETTINGNAME_AUDIT_CONFIG server config setting. |
| PT_AUTHSOURCE_SETTINGS | Deprecated interface used for a bitmask of auth source settings. |
| PT_AUTHSOURCE_SUPPORTSSYNCMODES | Constant class which details the capabilities of auth sources: authentication (verification of users' identity on login) and/or synchronization (import of users and groups into Plumtree). |
| PT_AUTHSOURCEPROV_GROUPMEMBERSHIP_COLS | Defines an additional column returned by auth source providers in group membership queries. |
| PT_AUTHSOURCEPROV_USERGROUP_COLS | Defines the columns returned by auth source providers in user and group queries. |
| PT_AUTHSOURCEPROVIDER_CAPABILITIES | A list of optional capabilities that an auth source provider may support. |
| PT_AUTHTYPES | Enumeration of auth types for auth sources. |
| PT_BOOLOPS | Boolean operators (AND and OR) as used in Plumtree filters- the filter operator is a PT_BOOLOPS. |
| PT_CARD_SETTINGS | Plumtree Card Settings. Note that some of these settings are persistant and some aren't, Some are for new cards only and some aren't. Some are for internal use only. |
| PT_CARDREF_STATES | Plumtree Card Approval States. Card approval is done per Card per Folder. Thus, a card can be approved in certain Folders but not others. Methods for the approval of Cards can be found in IPTCatalog |
| PT_CARDREFRESHSETTING | Plumtree Card Refresh Settings |
| PT_CARDREFRESHSETTINGCOLUMNS | Plumtree Card Refresh Setting Columns |
| PT_CATALOG_SETTINGS | Plumtree Catalog settings. This is currently not used. |
| PT_CATALOGOBJ_STATUS | This list contains the possible status of objects in the Search Server. This is used to indicate to the Search Update Agent whether an object needs to be indexed, updated, or removed from the search index. |
| PT_CHILDNODE_INDICES | This list contains the different types of information about a Child Node during a Crawl |
| PT_CLASSIDS | Lists all classes, or types, of objects supported by Plumtree |
| PT_COMMUNITY_MEMBERSHIPTYPE | Enumeration of the different membership types of a Community. Community membership only controls if a Community shows up in users My Communities list, also possibly as a mandatory tab. |
| PT_CONTAINER_OPERATIONS | This list contains the possible Scheduled Folder Operations. They are used by the UI for launching asynchronous job operations that possibly take too long to run synchronously. |
| PT_CP_CAPABILITIES | This list is used to check the capabilities of a Crawl Provider. It is used by IPTDataSourceCrawlProvider.QueryCapability |
| PT_CRAWL_CONTAINER_INFO | This list contains the different types of information about Folders during a Crawl. It is used by IPTDataSourceCrawlProvider.GetContainerNodeInfo |
| PT_CRAWL_INFO | This list specifies the different parameters that a Crawl can have |
| PT_CRAWL_PROVIDER_CAPABILITY_VALUES | This list contains the possible values for the capabilities listed in PT_CP_CAPABILITIES |
| PT_CRAWLER_SETTINGS | This list defines a list of settings for a Crawler. All settings are independent, bit-mapped flags. |
| PT_CRAWLPROVIDER_GETCHILDNODEMASK | This list specifies the bitmask used to retrieve information about a Child Node |
| PT_DATASOURCEPROVREGISTRY_CRAWL_CAPABILITIES | Data Source Crawl Capabilities bit mask used by the Data Source Provider Registry |
| PT_DOC_ACTION_TYPES | Enumeration of search indexing action codes, used by {@link com.plumtree.server.IPTIndexer} to return information about the success or failure of indexing requests. |
| PT_DOCTYPEMAP_MAPPINGS_INDICES | |
| PT_DOCUMENT_TYPE_APPROVAL_SETTINGS | |
| PT_DSPROVIDER_CAPABILITIES | A list of optional capabilities that a data source provider may support. |
| PT_DSPROVIDER_CAPABILITY_VALUES | Does this data source provider support crawling? |
| PT_EDIT_ACTIVITY_COLUMNS | Identities of columns used in edit activities. Two-dimensional arrays are used for all edit actions; this enum is used to identify the columns used int he key-value pair arrays |
| PT_EDIT_BULK_PROPDATA_COLUMNS | |
| PT_EDIT_PICKLIST_ACTIONS | |
| PT_EDIT_PICKLIST_COLS | |
| PT_EDIT_PROPDATA_COLUMNS | |
| PT_FEDERATEDPORTALPROVIDER_CAPABILITIES | |
| PT_FEDERATEDPORTALPROVIDER_CONFIGURATIONS | |
| PT_FEDERATEDPORTALPROVIDER_SESSIONKEYS | These constants are used by the FederatedEncryptionProvider to record what type of key should be used for encryption/decryption |
| PT_FEDERATEDSEARCHMODES | These constants define the allowed search modes for Federated Searches |
| PT_FIELDARRAY_INDICES | Indices for Field arrays returned by Accessors and Data Source Providers. This will also be used for the CommonFields. In the case of CommonFields, the PT_FIELDARRAY_VALUE column holds the description. |
| PT_FILTER_ITEM_TYPES | Filter Item Types are used to set the type for IPTPropertyFilterItems. |
| PT_FILTER_SETTINGS | These constants define the settings that can be set or retrieved for an IPTFilter |
| PT_FILTEROPS | The FILTEROPS constants define the operators that are supported in query filters. These are used in ObjectManager queries, etc. |
| PT_FILTERTYPES | These constants define the types of filters that the IPTFilter interface can support. |
| PT_FOLDER_SETTINGS | |
| PT_FOLDER_SUBMITACCESSLEVELS | |
| PT_FOLDERSEARCH_SETTINGS | Obsolete. Enumeration for settings governing folder searches. See {@link com.plumtree.server.PT_SEARCH_SETTING} instead. |
| PT_GADGET_ALIGNMENTS | Portlet alignment values. Describes the placement of the portlet on a page. |
| PT_GADGET_COLUMNS | Gadget column enumerator. Simply used as a base index for columns in a page where a gadget resides. This base value indicates the gadget has no column, or is in the first column on a wide-only layout. |
| PT_GADGET_FLAGS | Flags for gadgets. Pretty small list right now; stored as a gadget pref. Currently we support the supression of a gadget's titlebar. |
| PT_GADGET_MODES | Defines the mode or context in which a portlet runs. |
| PT_GADGET_TYPES | The type of portlet. |
| PT_GADGETINFO_SETTINGS | DEPRECATED Gadget info enumerator. Origianlly used to address the gadget information cache elements. These were Plumtree-specific gadget settings for 4.5WS. No longer supported. This code has been replaced with admin settings. |
| PT_GADGETPERSONALIZATION_ROLES | A bitmask of the types of personalization that a web service supports. |
| PT_GADGETPROVIDER_CAPABILITIES | A list of optional capabilities that a portlet provider may support. |
| PT_GLOBALOBJECTS | Global objects are opened through IPTSession.OpenGlobalObject. They are similar to other Plumtree administrative objects, except that they are singletons. You cannot create more than one instance of global objects, and you cannot delete an existing instance. |
| PT_IMAGE_FORMATS | |
| PT_INTERNAL_SETTINGS | |
| PT_INTRINSICS | These constants represent the ObjectIDs for intrinsic Plumtree objects- objects that should be in every system, and cannot be deleted |
| PT_JOB_SETTINGS | |
| PT_JOBSERVERSTATUS | |
| PT_JOBSTATUS | |
| PT_LOCALIZED_STRINGS_INDICES | Indices of the columns in the 2D array returned by IPTLocalizable. GetLocalizedNames() and IPTLocalizable.GetLocalizedDescriptions() |
| PT_LOCKSTATES | These constants define the lock states for server objects, as returned by IPTServerContext.GetLockState() |
| PT_LOGLEVELS | Log levels are used by Scheduled Operations to decide how much logging they should perform to the Job Log |
| PT_MANDATORYORDERING | Mandatory ordering priority. These values signify where in the Z-order (the vertical order a gadget appears in which a gadget appears in a column) the mandatory gadgets will appear. All mandatory gadgets appear in Column 0, no matter what the page layout is. Since non-mandatory gadgets may have a Z-order (column order) of zero, these numbers are treated as negative numbers; the Z-order is actually 99 - (mandatory ordering number). Mandatory gadgets with identical order are sorted randomly. |
| PT_MARKUP_ARRAY_COLS | Defines the columns of the array of markup fragments returned by a web service, including finished markup and unfinished portions that require further processing. |
| PT_MARKUP_FRAGMENT_TYPES | Defines the type of each fragment in the array of markup fragments. |
| PT_MIGRATION_CLASSES | |
| PT_MIGRATION_OBJECT_COLS | Indices of the columns in the 2D array returned by IPTMigrationManager.UUIDToObjectID |
| PT_MIGRATION_STATUS_TYPES | These constants define the Migration Statuses supported in Plumtree objects. These statuses can be used in functions like IPTMigrationManager. QueryObjectsByStatus or IPTMigrationManager.QueryObjectsByStatusCount. |
| PT_MSGTYPES | Log message types used when logging job messages, for example in InternalSession.JobLogMsg |
| PT_OBJECT_DEPENDENCY_COLS | Indices of the columns in the 2D array returned by IPTMigrationElement.GetDependencies |
| PT_OBJECT_DEPENDENCY_TYPES | These constants define the types of dependency that one migration element can have on another migration element. The PT_ODC_DEPENDENCY_TYPE column in the data returned by the IPTMigrationElement.GetDependencies call will be a value from the PT_OBJECT_DEPENDENCY_TYPES constants. |
| PT_ORDERBY_SETTINGS | These constants define the order (ascending or descending) for ObjectManager queries |
| PT_OVERRIDE_DEFAULT_INDICES | |
| PT_PAGE_TEMPLATE_JOB_TYPES | Page template job types. When you change a page template, that change must be propogated through all communities using that page template; the job type helps guide what the automation server does when it executes the ABO. |
| PT_PAGE_TYPES | Page types. Not used; future support for special page types. |
| PT_PICKTABLE_COLUMNS | Picktables are described by a 2D array. Each row in the array describes a column in the picktable, while the columns in the array are described in this enum. For example, if a picktable were created with SQL like: CREATE TABLE TESTPICKTABLE ( EMPNAME VARCHAR(255), DEPT VARCHAR(255), DEPTORDER INTEGER); the descriptive array might look like: "EMPNAME"\u0009\u0009"EMPNAME" "DEPT"\u0009\u0009\u0009"DEPTORDER" |
| PT_PICKTABLE_TYPES | Enumerates the allowed types of picklist tables. When Properties are associated with picklists, the administrator must specify the type of the picklist as a choice from this enum. |
| PT_PORTALOBJECT_TYPES | Portal object types. IPTPortalObject is the base class for all pages; the type allows for intelligent casting of the underlying class. Types include mypages, community pages, and the not-used type of "my community pages". |
| PT_PREF_TYPES | |
| PT_PROFILE_UNIQUE_KEYS |
Defines the meaning of special property IDs used by the IPTProfileSource interface as unique keys for profile syncs. These settings are mainly used in conjunction with the SetPortalUniqueKey() and GetPortalUniqueKey() functions on IPTProfileSource. |
| PT_PROFILER_MODE | Enumeration for different profiling (aka taxonomization) options. These values are passed to {@link com.plumtree.server.IPTIndexer} in the CommitAsProfiled(int) method. This enumeration is nominally public, but is intended only for internal Plumtree use. |
| PT_PROFILESOURCE_STATUS | Return values for the profile provider's AttachToUser. |
| PT_PROPAGATE_SECURITY_MODES | These constants control how IPTAdminCatalog.PropPropagateAdminFoldersSecurity propages ACL state from parent folders to child folders |
| PT_PROPERTY_CHARACTERISTICS | Values in this enum can be passed into IPTProperty.GetCharacteristicsAsXXX or SetCharacteristics. This is the complete list of valid characteristics for Properties. |
| PT_PROPERTY_TYPES | Every Plumtree IPTProperty is typed with a value from this enum. These values can be passed into IPTProperty.Initialize, and are returned from IPTProperty.GetType |
| PT_PROPERTYARRAY_INDICES | |
| PT_PROPIDS | These constants define the properties that can be retrieved from ObjectManagers when querying them for objects. For example, a bitmask of these values can be passed into IPTObjectManager.Query, and these constants can be passed into IPTQueryResult methods like IPTQueryResult.ItemAsXXX or IPTQueryResult.ContainsPropID. bitmasks from 1 to 32768 are basically common object properties, while values of 65536 and above are for object properties specific to a given class. To add new properties, simply find the highest bitmask that exists for your class and multiply it by 2. |
| PT_PROVIDER_CLSIDS | Lists all Provider Class IDs |
| PT_PROVIDER_DOC_TYPE_MAP_SECTIONS | Defines a list of sections that should appear in the Document Type Map. |
| PT_REGISTRYTYPES | These constants define the available Plumtree registries, and can be passed into IPTSession.OpenRegistry |
| PT_RELATED_RESOURCES_ACCESS_TYPES | These constants define which Related Resource types in a particular SubPortal can be seen. These bitmasked values are used in IPTSubPortal. GetRelatedResourcesAccessType and IPTSubPorta.SetRelatedResourcesAccessType |
| PT_RESULTCODES | These constants enumerate result codes that could appear in errors thrown by the Plumtree Portal. |
| PT_SCHEDULE_SETTINGS | |
| PT_SCHEDULE_SUSPEND_MODES | |
| PT_SCHEDULETYPES | |
| PT_SEARCH_ABSTYPES | "Abstract types" to be searched as part of an IPTSearchRequest. These are bits that may be ORed together to form a legal value for the PT_SEARCH_SETTING.PT_SEARCHSETTING_ABSTYPES setting (set by calling IPTSearchRequest.SetSettings). The main use of this enumeration is to enable searches for any type of document across different applications. The portal, Collab, and Content have different types that all hold "document" text content, but each of these types is returned by a search for PT_SEARCH_ABSTYPES_DOCUMENTS. |
| PT_SEARCH_APPS | Applications to be searched as part of an IPTSearchRequest. These are bits that may be ORed together to form a legal value for the PT_SEARCH_SETTING.PT_SEARCHSETTING_APPS setting (set by calling IPTSearchRequest.SetSettings). |
| PT_SEARCH_INTERNAL_FIELD | This enumeration lists special "internal fields" that can be requested by calling IPTSearchResponse.GetResultInternalField. These are items that do not correspond to Plumtree properties and whose importance does not merit a separate IPTSearchResponse method. All have values of type String; in some cases the String simply contains a formatted integer. |
| PT_SEARCH_SETTING | These are settings that can be get and set on an IPTSearchRequest, via GetSettings() and SetSettings(). The value type and default value for each setting id is indicated here. |
| PT_SEARCH_WARNING | This enumeration lists all the warning codes that can be returned by IPTSearchResponse.GetWarning. The existence of a nonzero warning code does not indicate that the search failed, but it does indicate some condition that had an effect on the returned results and that should be presented to an end-user. |
| PT_SEARCHACCESS_SETTINGS | This (vaguely named) enumeration lists legal values for IPTSearchRequest's PT_SEARCHSETTING_TIMEOUT setting. |
| PT_SEARCHCOLLECTION_SETTINGS | This enumeration lists legal setting IDs that may be used in a call to IPTIndexer.GetSettings() or IPTIndexer.SetSettings(). |
| PT_SEARCHES | Obsolete. Enumeration for indicating the scope of searches. See {@link com.plumtree.server.PT_SEARCH_SETTING} instead. |
| PT_SEARCHUPDATE_SETTINGS | |
| PT_SERIALIZED_LOCALIZED_STRINGS_COLS | Localized strings (object names and descriptions) that are stored by the server can be serialized to an array through the IPTStringLocalizationManager.GetLocalizedStrings and IPTStringLocalizationManager.SetLocalizedStrings calls. Some of the columns in the resultant array are in known locations, as defined by these constants. However, the width of the array is variable, as different Portals will support different languages. Columns starting at index PT_SLS_TARGET_STRING_START contain the strings for each language (i.e. if the Portal supports 4 languages, the array will have PT_SLS_TARGET_STRING_START + 4 columns.) |
| PT_SERVER_CONFIG_SETTINGID | |
| PT_SERVER_CONFIG_SETTINGNAME | These constants define the settings that can be set or retrieved through the IPTServerConfigSettings interface |
| PT_SERVERCONSTANTS | A grab bag of lower and upper limits on values used by the Server |
| PT_SERVERCONTEXT_SETTINGS | These constants define the settings supported by IPTServerContext. GetSettings and IPTServerContext.SetSettings |
| PT_SESSION_SETTINGS | These constants define the settings that can be set or retrieved through the IPTSession.GetSettingsAsXXX and SetSettings calls |
| PT_SESSIONSTATE_OBJECTS | Used by IPTSession.OpenGlobalObject when PT_GLOBALOBJECTS. PT_GLOBAL_MYPORTAL is passed in. For backwards compatibility, OpenGlobalObject has to open the proper MyPortal (which may be a MyPage or a Community page.) These values are used to remember the state. |
| PT_STATEMODES | These values can be passed to IPTStates.Get to return the approprate IPTState object |
| PT_STOREDPROC_PARAMTYPES | |
| PT_SUBPORTAL_ACCESS_TYPES | Subportal access types. The consumer of the subportal must be either a mypage a community, or a directory. Other page types, such as login, are irrelevant for the purposes of subportal access type. |
| PT_SUGG_DOC_TYPE_MAP_ENTRIES_INDICES | Indices for suggested Document Type Map Entries |
| PT_SYNCTYPES | Enumeration of sync types for auth sources. |
| PT_TAXONOMIST_SETTINGS | |
| PT_UPGRADE_DATATYPES | Datatypes for data used in IPTUpgradeManager |
| PT_UPGRADE_PARAMETERS_COLS | Indices of the columns in the 2D array returned by IPTUpgradeManager. QueryParametersRequiredForUpgrade and passed to IPTUpgradeManager. PerformUpgrade |
| PT_URL_TYPES | |
| PT_USER_TYPES | |
| PT_WEBSERVICE_CARDSUBMIT_TYPES | |
| PT_XML_ARRAY_COLS | Markup fragments of type PT XML are returned as 2D arrays with these columns. |
| PT_XML_TYPES | Markup fragments of type PT XML are returned as 2D arrays with these columns. |
| Interface | Description |
|---|---|
| IPTAccessList | An Access List describes the security attributes of a Plumtree Object. An Access List is a collection of Access List Entries. Each Access List Entry describes a level of access that has been assigned to a particular user or group. |
| IPTAccessListEntry | An Access List describes the security attributes of a Plumtree Object. An Access List is a collection of Access List Entries. Each Access List Entry describes a level of access that has been assigned to a particular user or group. |
| IPTAccessor | An IPTAccessor is an external component that knows how to parse a particular type of document and return metadata found in the document |
| IPTAccessorRegistry | A registry for Accessors that are known to the system |
| IPTACLSyncMap | |
| IPTActivityGroups | Interface used for granting rights to groups, revoking rights from groups, and querying for the rights of a group. |
| IPTAdminCatalog | All administrative objects in Plumtree are stored in a foldering system. The folders are called Admin Folders, and the Admin Catalog is the container for the Admin Folders. |
| IPTAdminFolder | All administrative objects in Plumtree are stored in a foldering system. The folders are called Admin Folders, and the Admin Catalog is the container for the Admin Folders. |
| IPTAdminSettings | This interface is used to retrieve and set the Administrative settings on a Gadget. Administrative settings apply to every instance of a Gadget, regardless of the page on which it appears or who views it. For instance, consider a Gadget that connects to a back-end database to retrieve human resources information. The exact information retrieved will differ from user to user, but the connectivity information for the Gadget should be the same no matter where the Gadget is viewed. This connectivity information would be an example of an Administrative setting. |
| IPTAsyncGadgetProvider | The interface implemented by portlet providers that support asynchronous processing. Providers are initialized once and then cached. To render a community or a mypage, the server calls BeginProcessing once for each provider, then calls GetHTMLText once for each provider, passing the same arguments that were passed to BeginProcessing. -jas |
| IPTAuditManager | This interface is used to manage the audit trail for changes to Plumtree objects. For instance, it's used to query existing audit messages, to delete defunct messages, and to control the level of auditing that Plumtree will perform. |
| IPTAuthSource | Authentication Source objects provide authentication for plumtree users, as well as synchronization with external user repositories. |
| IPTBulkSubscriber | |
| IPTCard | |
| IPTCardPropertyValue | |
| IPTCardPropertyValues | |
| IPTCardRefreshAdmin | |
| IPTCardRefreshAgent | |
| IPTCardRefreshInfo | |
| IPTCatalog | The interface representing the Knowledge Directory (Catalog). The Knowledge Directory allows you to browse, move, create, and edit document links (cards) and document folders. It also manages the filters and related resources associated with each folder. Objects in the knowledge directory can be created directly through this interface. |
| IPTCatalogStatistics | |
| IPTCommunity | |
| IPTCommunityInfo | |
| IPTCommunityManager | |
| IPTCommunityTemplate | |
| IPTContent | Returns gatewayed content. This abstraction should be able to represent either a web response or a file and provide enough information for the content to be served up over HTTP. -jas |
| IPTCookieInfo | Used to forward a Single Sign-On cookie. |
| IPTCrawler | |
| IPTCrawlerManager | |
| IPTCustomFileAccessor | |
| IPTDataSource | |
| IPTDataSourceACLSyncProvider | |
| IPTDataSourceProvider | |
| IPTDataSourceProviderRegistry | |
| IPTDocumentType | Interface for IPTDocumentTYpe |
| IPTDocumentTypeMap | Interface for IPTDocumentTypeMap |
| IPTExternalOperation | JHQ 050604: External Operations have been re-architected to run script files instead of commands from the command line. These scripts must reside in the automation server's portal_home/scripts directory. This directory can be secured as necessary. Therefore, we no longer use the RunAsUser/RunAsUserPassword. Corresponding methods will be deprecated and should not be implemented. |
| IPTFederatedEncryptionProvider | |
| IPTFederatedPortal | The term Federated Portal refers to a remote Plumtree Portal that is part of a network of Plumtree Portals that work together to deliver content. For example, a large international organization may have a Portal install that primarily serves their North American employees, and a separate Portal install that primarily serves their European employees. These Portals may be federated, enabling users of each Portal to search for content in the other Portal in a relatively seamless manner. The IPTFederatedPortal interface is used within one Portal instance to represent data about a second, Federated Portal. |
| IPTFederatedPortalManager | A Federated Portal is accessed by issuing a Federated Search to it. This interface allows clients to ask the Federated Portals ObjectManager for a Federated Search with which to perform queries. |
| IPTFederatedSearch | Federated Searches are used to access data on remote Federated Portals. A single Federated Search can execute searches against multiple Federated Portals concurrently. |
| IPTFederatedSearchAgent | This is the interface for the federated search agent. It allows another portal to request a federated search of this portal. More specifically, in the COM implementation, the server side of a federated search request is handled by PTFederatedSearchServer (in the Extensibility package). PTFederatedSearchServer creates an PTSearchProxy, which instantiates an IPTFederatedSearchAgent, which, in turn, creates local portal search objects (e.g. IPTSearchRequest) to actually run the search. |
| IPTFederatedSearchProvider | An IPTFederatedSearchProvider is an external component that knows how to perform searches in external systems and return search results to Plumtree |
| IPTFederatedSearchProviderRegistry | A registry for Federated Search Providers that are known to the system |
| IPTFileUploadAgent | |
| IPTFilter | |
| IPTFolder | |
| IPTGadget | The Gadget interface wraps access to a specific portlet instance. This allows you to query the HTML content of a portlet, get and set properties, import and export, execute a job operation (in this case write HTML to the disk). |
| IPTGadgetAssociatedContentProvider | The interface implemented by provider that wish to expose associated content files to the portal. Each piece of content will have an identifier (an URL for HTTP gadgets, for example). There are some predefined constants for getting particular content that only the provider knows about such as a preferences page, see {@link com.plumtree.server.PT_ASSOCIATEDCONTENT PT_ASSOCIATEDCONTENT}. -jas |
| IPTGadgetBundle | |
| IPTGadgetCacheSite | Object used to hold gadget data in the gadget cache. Wraps the disabled and normal gadget cache entries into a single manageable entry. |
| IPTGadgetContentServer | This interface wraps access to a specific remote server instance. A remote server is an object that stores connection information shared by multiple web service objects. |
| IPTGadgetGateway | A global object available from the session via {@link com.plumtree.server.IPTSession.OpenGlobalObject OpenGlobalObject} that retrieves associated content via an HTTP gateway. -jas |
| IPTGadgetInfo | IPTGadgetInfo |
| IPTGadgetProviderRegistry | A registry for Gadget Providers that are known to the system |
| IPTGadgetTemplate | PTGadgetTemplate interface. Wraps a template object that contains all properties necessary to instantiate a new gadget. |
| IPTGenerateState | This is a secondary interface optionally implemented by data source providers to assist the UI to to generate a property bag describing a document from this data source. The provider must be initialized to use this interface. |
| IPTGuestLogin | IPTGuestLogin defines the guest-user experience during an unauthenticated session, up to the point where the user is successfully authenticated. IPTGuestLogin includes settings to indicate which guest user to use (during the unauthenticated portion of the session) and which authentication method to use for logging in the user (whether SSO should be used, whether gatewayed content click-through should be authenticated, etc). After the user is successfully logged in (i.e., the user is no longer a 'guest'), the settings in the IPTGuestLogin will no longer apply (except perhaps the settings for logging off the user to get back to the 'guest' user status). IPTGuestLogin is typically used in concert with the SubPortal Expression Engine, to create conditional actions for choosing which IPTGuestLogin to use, based on conditions such as the client IP address, the request URL, the browser's agent, etc, allowing different guest users and different authentication methods (SSO or not) to be used for different incoming requests. |
| IPTGuestLoginInfo | This is the Info object of IPTGuestLogin. |
| IPTGuestLoginManager | |
| IPTIndexer | Interface for class which manages the indexing, updating, and deleting of cards, folders, and administrative objects. The methods in this interface are not intended for general custom use, they are intended for use by Plumtree server, crawler, and agent code. |
| IPTInvitation | Administrative and browsing interface for modifying and accessing an invitation. |
| IPTJob | |
| IPTJobDispatcherService | |
| IPTLDAPQueryTool | This interface provided simple LDAP query functionality for previous versions of Plumtree. It has been deprecated, as the LDAP Authentication Source Provider will not be supported in future versions of Plumtree. |
| IPTListManager | General interface which is mean to be used for the addition, deletion, and edit of a list of simple "objects". These methods are meant to directly modify the database so there is no in-memory representation of the "object". |
| IPTLocalizable | This interface is supported by objects that support localization of their names and descriptions. Localization allows a single object to have different strings for different languages- the name or description can be different for English and French speakers, for example. |
| IPTLockManager | Used to query for locked Plumtree objects, unlock locked objects, and clear expired object locks. |
| IPTLogAnalysis | |
| IPTMigratable | This interface is implemented by objects that are migratable via Object migration. All objects implementing the IPTObject interface in the server should also implement this interface. Non-IPTObjects that need to be migrated via the Object Migration framework should also implement this interface. |
| IPTMigrationElement | This interface represents an intermediate format for serialized Plumtree objects. Objects implementing the IPTMigratable interface will serialize themselves to/from this format using methods on the IPTMigrationElement interface. This intermediate format can also be stored and loaded from a migration package via the IPTMigrationManager interface methods. |
| IPTMigrationManager | This interface manages the Import and Export of migration packages of Plumtree objects into/out of a system. It also provides methods used by the UI to perform various queries related to migration. |
| IPTMigrationProvider | Interface for Migration providers which allow remote applications to plug migration features into the migration utility. |
| IPTMyPages | IPTMyPages |
| IPTMyPortal | IPTMyPortal |
| IPTMyPortalGadgetContent | IPTMyPortalGadgetContent |
| IPTObject | This is the fundamental interface for all Plumtree administrative objects. It defines base object functionality, such as class type, Last Modified dates, etc. |
| IPTObjectLock | Internal interface used for locking and unlocking Plumtree objects. |
| IPTObjectManager | Object Managers are used to create, open, copy, delete, and find administrative objects. Each class of object is associated with a particular Object Manager. |
| IPTObjectProperties | Modify and retrieve property data associated with object-manager managed objects, administrative folders, and document folders. |
| IPTObjectPropertyMap | Retrieve and modify property to class mappings for object properties. Before property data can be added to an object, a mapping must exist between a property and the class of the object. |
| IPTPage | |
| IPTPageContainer | |
| IPTPageInfo | |
| IPTPageManager | |
| IPTPageTemplate | IPTPageTemplate |
| IPTPersist | IPTPersist is implemented by objects that wish to support standardized persistence to and from the Plumtree database. Most Plumtree objects support IPTPersist, e.g. Users, Data Sources, etc. |
| IPTPickListEditor | Modify the values of a managed pick list. This interface directly interacts with the database (there is no in-memory representation of a pick list). Picktrees and unmanaged pick lists cannot be edited using the Plumtree API, and can only be modified via SQL. |
| IPTPreferencesContext | |
| IPTProfileManager | Interface to access information about user profiles. |
| IPTProfilePage | Used to store user profile layout information in the database. A profile page consists of several profile sections, which consist of several properties. Confusingly, in the UI a profile page is called a "Section." |
| IPTProfileSection | Used to store user profile layout information in the database. A profile page consists of several profile sections, which consist of several properties. Confusingly, in the UI a profile section is called a "Category." |
| IPTProfileSource | Profile source objects import user profile information from external repositories. |
| IPTProperty | A Property represents normalized extended metadata about Plumtree objects. For example, a Card contains metadata such as the Card name, last modified date, etc. This is "standard" Plumtree metadata. A Card may also contain information such as the author of the underlying document, or the last modified time of the file. This data is associated with particular, named Properties (such as the "Author" Property.) |
| IPTPropertyFilterClauses | A PropertyFilterClauses element is an element within a filter that contains PropertyFilterStatements and other PropertyFilterClauses. Through the use of PropertyFilterClauses, a filter can contain a "tree" of conditions, and can be arbitrarily complex. See the documentation on IPTPropertyFilterItem for information on the relation between clauses, items, and statements. |
| IPTPropertyFilterItem | Filters are used in Plumtree to perform queries- the filter is used to specify which items should be returned in the query. Filters are collections of constraints. Each constraint is an IPTPropertyFilterItem. Some constraints are atomic, in that they specify a match condition (e.g. "Name = 'Fred'"), while others are compound constraints (e.g. "Name = 'Fred' and Department = 'Legal'".) Atomic constraints implement the IPTPropertyFilterStatement interface, while compound constraints implement the IPTPropertyFilterClauses interface. Both of those interfaces are subclasses of this interface- this interface is the base class for all types of filter constraints. |
| IPTPropertyFilterStatement | A PropertyFilterStatement is an element within a filter that specifies an atomic condition, such as "Name = 'Fred'". PropertyFilterStatements can be combined through the use of IPTPropertyFilterClauses. See the documentation on IPTPropertyFilterItem for information on the relation between clauses, items, and statements. |
| IPTPropertyMap | The Property Map provides a mapping of Card Properties to Document Attributes |
| IPTQueryFilter | |
| IPTQueryResult | IPTQueryResult are returned by many server calls. They contain 2D arrays of "raw" data, as well as descriptive metadata (such as sorting information, the properties that are included in the results, etc.) The data is arranged into rows and columns. Each row corresponds to a data set, and each column corresponds to a property about the data set (a property as defined in PT_PROPIDS.) For example, when use the User Object Manager to request a list of User objects in an Administrative Folder, the resulting IPTQueryResult will have a row for each User, and columns for properties like PT_PROPID_OBJECTID and PT_PROPID_NAME When requesting data from a IPTQueryResult, the client typically knows the property that's desired , but does not necessarily know what column stores that data. The IPTQueryResult interface abstracts away the need to know which column contains what data- when requesting a cell from the IPTQueryResult, the client only has to specify row and property ID. |
| IPTRegAccess | |
| IPTRemoteMigrationContext | This interface is used for remote migration of portlets. |
| IPTSavedSearch | |
| IPTSavedSearchManager | |
| IPTSchedule | |
| IPTScheduledOperation | IPTScheduledOperation is the internal interface used to run job operations. A job consists of a list of these operations and will run them in serial. A well-known list of objects that implement this interface is returned through a call to IPTSession.OpenGlobalObject( PT_GLOBALOBJECTS.PT_GLOBAL_SCHEDULED_AGENTS ). This API is provided to the Automation Server to call into the agent code. Customers should avoid using this interface directly as it will not be supported going forward. The one method that can be used outside the Automation Server context is ScheduleImmediateJob(). |
| IPTScheduler | |
| IPTSearchMaintenance | |
| IPTSearchQuery | Interface that encapsulates one search query; used with (and manufactured by) IPTSearchRequest. This interface has several portal implementations, including a simple text search query, an advanced property filter-based query, and various forms of queries associated with drilling down into categories generated as part of a previous search result. Clients of the search interface usually do not need to call any of the methods on this interface. Search queries are manufactured by an IPTSearchRequest and are basically opaque to clients. |
| IPTSearchRequest | |
| IPTSearchResponse | IPTSearchResponse contains the results of a single search; it is returned by IPTSearchRequest.Search() and FollowupSearch(). It contains methods to retrieve information about items matching the search, categories (groups) identified, and spelling corrections made in the course of executing the search. |
| IPTServerConfigSettings | The IPTServerConfigSettings interface is used to set and retrieve global Plumtree Server settings. The settings are stored in the database, and thus accessible to all instances of Plumtree that share the same database (i.e. the settings are available to every instance of Plumtree within a single install.) Changes to settings generally do not take effect until the Plumtree process has been restarted- Plumtree does not have a facility to notice that global settings have been reset in the database, and that in-memory copies of those settings should be updated. Settings are identified by unique integers. The known setting IDs are enumerated in the {@link com.plumtree.server.PT_SERVER_CONFIG_SETTINGNAME PT_SERVER_CONFIG_SETTINGNAME} class. |
| IPTServerContext | The IPTServerContext interface is used to set and retrieve object metadata that is common to Plumtree objects. The following metadata can be set/retrieved via the IPTServerContext interface: - The object's ID - The object's owner - The ACL of the object - The user that last modified the object - The lock state of the object In addition, the Session used to instantiate the object can be retrieved, as well as that Session's access level to the underlying object. Finally, the SetServerContextSettings() and GetServerContextSettings() methods set and retrieve flags that control the behavior of the Store() method of the IPTStorable interface, which IPTServerContext extends. These flags are specified in the PT_SERVERCONTEXT_SETTINGS enumeration. |
| IPTSession | The IPTSession interface is the main entry point into the Portal API. It provides methods for connecting into the system, authenticating, and instantiating and accessing other portal objects. |
| IPTSessionInfo | This object caches the user specific items on the IPTSession (specifically, on its InternalSession). The methods on this interface access cached information that might otherwise be expensive to query from the database every time. |
| IPTSessionPrefChangeNotification | This interface defines the method to be called when there's a change in session prefs. |
| IPTSiteMapFolder | IPTSiteMapFolder |
| IPTSiteMapFolderInfo | IPTSiteMapFolderInfo |
| IPTSiteMapFolderManager | IPTSiteMapFolderManager |
| IPTSiteMapLink | IPTSiteMapLink |
| IPTSSOInfo | Used to store information which will be sent in portlet and gateway requests. |
| IPTState | The IPTState interface provides a means to pass in request-specific variables from the UI into the server. It is used to store and retrieve name-value pairs where names are strings, and values can be any type of object. |
| IPTStates | This interface is a container for managing a collection of IPTState objects. |
| IPTStorable | Objects that can be stored implement the IPTStorable interface |
| IPTStreamScroller | |
| IPTStringLocalizationManager | This interface is used to download or upload all localized strings in the Server in one batch (that is, localized names and descriptions for Plumtree objects.) Generally, this will be used to employ third party localization firms to localize strings. The steps would be like: 1. Mark Plumtree objects to be localized with the "supports localization" flag in the Plumtree UI 2. Export the list of localized objects via a call to IPTStringLocalizationManager.GetLocalizedStrings (the Plumtree UI calls this and converts the results to XML) 3. Send the strings to a translator (or translators) for converting from the primary language to each of the supported localized languages 4. Reimport the list of localized objects, with the localized names filled in |
| IPTSubPortal | |
| IPTSubPortalInfo | |
| IPTSyncSingleNTDomain | |
| IPTTaxonomist | This class defines an object that performs taxonomization. Taxonomization is the process of classifying Documents into a set of Folders by using Filters, which define folder membership. |
| IPTTempfile | |
| IPTTestManager | |
| IPTTokenAccess | |
| IPTTrace | |
| IPTTransformer | For internal use only. |
| IPTUnknown | This interface exists only for backwards compatiblity with code written against the 5.0.x Windows server. It is deprecated and will be removed in a future release. |
| IPTUpgradeManager | Used to perform upgrades from Plumtree 4.5ws -> the current version of Plumtree. The Upgrade User Interface is the only client of this API. |
| IPTUser | IPTUser is the interface representing a portal User object. |
| IPTUserGroup | IPTUserGroup is the interface representing a portal UserGroup object. UseGroups can contain both users and groups. User memberships are either static or dynamic. The former are manipulated directly via the IPTUserGroup API. The later are based on rules, e.g. 'Country' contains 'USA', and are assessed by the Dynamic Membership Agent. The rule is specified using an IPTFilter and the IPTUserGroup API. |
| IPTUserInfo | UserInfo is information about the current user that is sent to portlets. UserInfo can be initialized with user profile information when a user logs in. |
| IPTUserInterface | Represents a type of user interface that a portlet or other web service may optionally support, such as wireless device portals. |
| IPTUserInterfaceManager | Object manager for IPTUserInterface objects. |
| IPTUserManager | Used to perform administrative tasks on users |
| IPTWebService | This interface wraps access to a specific web service instance. A web service object contains common settings and methods used by all types of web services in the portal, including portlets, AWS, CWS, SWS, PWS, etc. |
| IPTWebServiceManager |