com.plumtree.server
Class PortalObjectsFactory

java.lang.Object
  |
  +--com.plumtree.server.PortalObjectsFactory

public class PortalObjectsFactory
extends java.lang.Object

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. Clients should only import the "com.plumtree.server.*" 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.


Method Summary
static IPTAccessList CreateAccessList()
          Factory method for Plumtree ACL objects.
static IPTCardRefreshInfo CreateCardRefreshInfo()
          Factory method for Plumtree CardRefreshInfo objects.
static IPTFederatedSearchAgent CreateFederatedSearchAgent()
          Factory method for Plumtree FederatedSearchAgent objects.
static IPTMigrationElement CreateMigrationElement()
          Factory method for Plumtree MigrationElement objects.
static com.plumtree.openfoundation.util.IXPPropertyBag CreatePropertyBag()
          Factory method for Plumtree PropertyBag objects.
static IPTFilter CreateSearchFilter()
          Factory method for filters to be used for Advanced Search, snapshot queries, etc.
static IPTSession CreateSession()
          Factory method for Plumtree Session objects.
static IPTSSOInfo CreateSSOInfo()
          Factory method for Plumtree SSOInfo objects.
static IPTState CreateState()
          Factory method for Plumtree State objects.
static IPTTempfile CreateTempfile()
           
static IPTUpgradeManager CreateUpgradeManager()
          Factory method for Plumtree UpgradeManager.
static IPTUserInfo CreateUserInfo()
          Factory method for Plumtree UserInfo objects.
static void Init()
          Initialize the Portal Objects library.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

Init

public static void Init()
Initialize the Portal Objects library.

The portal application initialization method. This method can be optionally called by applications to do a one-time initialization of the underlying libraries.

If not called explicitly, factory methods may call this implicitly. This feature allows the API to be backwards compatible with the 5.0 PortalObjectsFactory behavior.


CreateSession

public static IPTSession CreateSession()
Factory method for Plumtree Session objects. All access to the portal system starts here.
Returns:
Plumtree Session

CreatePropertyBag

public static com.plumtree.openfoundation.util.IXPPropertyBag CreatePropertyBag()
Factory method for Plumtree PropertyBag objects.
Returns:
Plumtree PropertyBag

CreateAccessList

public static IPTAccessList CreateAccessList()
Factory method for Plumtree ACL objects.
Returns:
Plumtree AccessList

CreateCardRefreshInfo

public static final IPTCardRefreshInfo CreateCardRefreshInfo()
Factory method for Plumtree CardRefreshInfo objects.
Returns:
CardRefreshInfo

CreateFederatedSearchAgent

public static final IPTFederatedSearchAgent CreateFederatedSearchAgent()
Factory method for Plumtree FederatedSearchAgent objects.
Returns:
FederatedSearchAgent

CreateMigrationElement

public static final IPTMigrationElement CreateMigrationElement()
Factory method for Plumtree MigrationElement objects.
Returns:
MigrationElement

CreateSSOInfo

public static final IPTSSOInfo CreateSSOInfo()
Factory method for Plumtree SSOInfo objects.
Returns:
SSOInfo

CreateState

public static IPTState CreateState()
Factory method for Plumtree State objects.
Returns:
State

CreateUserInfo

public static final IPTUserInfo CreateUserInfo()
Factory method for Plumtree UserInfo objects.
Returns:
UserInfo

CreateSearchFilter

public static final IPTFilter CreateSearchFilter()
Factory method for filters to be used for Advanced Search, snapshot queries, etc.
Returns:
an empty IPTFilter, ready to be populated with clauses and statements

CreateTempfile

public static final IPTTempfile CreateTempfile()

CreateUpgradeManager

public static final IPTUpgradeManager CreateUpgradeManager()
Factory method for Plumtree UpgradeManager.
Returns:
PTUpgradeManager


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.