com.plumtree.server
Interface IPortalObjectsFactory

All Known Implementing Classes:
PortalObjectsFactoryService

public interface IPortalObjectsFactory


Method Summary
 IPTAccessList CreateAccessList()
          Factory method for Plumtree ACL objects.
 IPTBestBetTarget CreateBestBetTarget()
          Factory method for Plumtree BestBetTarget objects.
 IPTCardRefreshInfo CreateCardRefreshInfo()
          Factory method for Plumtree CardRefreshInfo objects.
 IPTFederatedSearchAgent CreateFederatedSearchAgent()
          Factory method for Plumtree FederatedSearchAgent objects.
 IPTGuestLoginInfo CreateGuestLoginInfo(int nSubPortalID)
          Factory method for Plumtree GuestLoginInfo objects.
 IPTMigrationElement CreateMigrationElement()
          Factory method for Plumtree MigrationElement objects.
 com.plumtree.openfoundation.util.IXPPropertyBag CreatePropertyBag()
          Factory method for Plumtree PropertyBag objects.
 IPTFilter CreateSearchFilter()
          Factory method for filters to be used for Advanced Search, snapshot queries, etc.
 IPTSession CreateSession()
          Factory method for Plumtree Session objects.
 IPTSSOAuthTokenGenerator CreateSSOAuthTokenGenerator()
          Factory method for Plumtree SSOAuthTokenGenerator objects.
 IPTSSOInfo CreateSSOInfo()
          Factory method for Plumtree SSOInfo objects.
 IPTState CreateState()
          Factory method for Plumtree State objects.
 IPTTempfile CreateTempfile()
           
 IPTUpgradeManager CreateUpgradeManager()
          Factory method for Plumtree UpgradeManager.
 IPTUserInfo CreateUserInfo()
          Deprecated.  
 IExpressionEngine GetExpressionEngineInstance()
          Factory method for the Plumtree Expression Engine.
 IPTSession GetGuestReadOnlySession()
          Returns a guest session that can be used for read access to server objects
 void Init(com.plumtree.openkernel.config.IOKContext context)
           
 void InitLight(com.plumtree.openkernel.config.IOKContext context)
          Initialize the Portal Objects library.
 

Method Detail

Init

void Init(com.plumtree.openkernel.config.IOKContext context)

InitLight

void InitLight(com.plumtree.openkernel.config.IOKContext context)
Initialize the Portal Objects library.

A simpler, lighter version of Init for clients that don't want full initialization


CreateSession

IPTSession CreateSession()
Factory method for Plumtree Session objects. All access to the portal system starts here. Callers MUST call Init before calling this function

Returns:
Plumtree Session

CreatePropertyBag

com.plumtree.openfoundation.util.IXPPropertyBag CreatePropertyBag()
Factory method for Plumtree PropertyBag objects.

Returns:
Plumtree PropertyBag

CreateAccessList

IPTAccessList CreateAccessList()
Factory method for Plumtree ACL objects.

Returns:
Plumtree AccessList

CreateBestBetTarget

IPTBestBetTarget CreateBestBetTarget()
Factory method for Plumtree BestBetTarget objects.

Returns:
CardRefreshInfo

CreateCardRefreshInfo

IPTCardRefreshInfo CreateCardRefreshInfo()
Factory method for Plumtree CardRefreshInfo objects.

Returns:
CardRefreshInfo

CreateFederatedSearchAgent

IPTFederatedSearchAgent CreateFederatedSearchAgent()
Factory method for Plumtree FederatedSearchAgent objects.

Returns:
FederatedSearchAgent

CreateMigrationElement

IPTMigrationElement CreateMigrationElement()
Factory method for Plumtree MigrationElement objects.

Returns:
MigrationElement

CreateSSOInfo

IPTSSOInfo CreateSSOInfo()
Factory method for Plumtree SSOInfo objects.

Returns:
SSOInfo

CreateGuestLoginInfo

IPTGuestLoginInfo CreateGuestLoginInfo(int nSubPortalID)
Factory method for Plumtree GuestLoginInfo objects.

Returns:
GuestLoginInfo

CreateState

IPTState CreateState()
Factory method for Plumtree State objects.

Returns:
State

CreateUserInfo

IPTUserInfo CreateUserInfo()
Deprecated. 

Factory method for Plumtree UserInfo objects.

Returns:
UserInfo

CreateSearchFilter

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

IPTTempfile CreateTempfile()

CreateUpgradeManager

IPTUpgradeManager CreateUpgradeManager()
Factory method for Plumtree UpgradeManager.

Returns:
PTUpgradeManager

CreateSSOAuthTokenGenerator

IPTSSOAuthTokenGenerator CreateSSOAuthTokenGenerator()
Factory method for Plumtree SSOAuthTokenGenerator objects.

Returns:
SSOAuthTokenGenerator

GetExpressionEngineInstance

IExpressionEngine GetExpressionEngineInstance()
Factory method for the Plumtree Expression Engine.

Returns:
ExpressionEngine

GetGuestReadOnlySession

IPTSession GetGuestReadOnlySession()
Returns a guest session that can be used for read access to server objects

Returns:
Plumtree Session