com.ibm.pim.context
Interface Context


public interface Context

Interface providing methods for Context

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void cleanUp()
          Clean up the resources that are used in the context.
 void commit()
          Commit transaction.
 SearchQuery createSearchQuery(java.lang.String queryString)
          Obtain a Query object for the specified query String
 AdminHelper getAdminHelper()
          Returns object of AdminHelper
 AttributeCollectionManager getAttributeCollectionManager()
          Gets the AttributeCollectionManager for this context
 AttributePathHelper getAttributePathHelper()
           
 CatalogManager getCatalogManager()
          Gets the CatalogManager for this context
 CollaborationAreaManager getCollaborationAreaManager()
          Gets the CollaborationAreaManager for this context
 java.util.List<com.ibm.icu.util.Currency> getCurrencies()
          Gets all the currencies supported by the system.
 User getCurrentUser()
          Returns the currently authenticated User object.
 Logger getDefaultLogger()
          Returns an instance of root Logger as defined in configuration file /etc/default/api_log.xml
 DocstoreManager getDocstoreManager()
          Gets the DocstoreManager for this context
 EnvironmentExporter getEnvironmentExporter()
          Gets the EnvironmentExporter for this context
 EnvironmentImporter getEnvironmentImporter()
          Gets the EnvironmentImporter for this context
 HierarchyManager getHierarchyManager()
          Gets the HierarchyManager for this context
 IISIntegration getIISIntegration()
          Returns object of IISIntegration
 JobManager getJobManager()
          Obtain a new JobManager object.
 java.util.List<java.util.Locale> getLocales()
          Gets all the locales supported by the system.
 Logger getLogger(java.lang.String loggerName)
          Returns an instance of Logger as defined in configuration file /etc/default/api_log.xml
 LookupTableManager getLookupTableManager()
          Gets the LookupTableManager for this context
 OrganizationManager getOrganizationManager()
          Gets the OrganizationManager for this context
 PIMScriptManager getPIMScriptManager()
          Gets the PIMScriptManager for this context
 RoutingManager getRoutingManager()
          Gets the Routing manager for this context
 SelectionManager getSelectionManager()
          Gets the SelectionManager for this context
 SpecManager getSpecManager()
          Gets the SpecManager for this context
 TimezoneResolver getTimezoneResolver()
          Gets a utility for processing timezone related information.
 UIHelper getUIHelper()
          Returns object of UIHelper
 WebServiceManager getWebServiceManager()
          Gets the WebServiceManager for this context
 WorkflowManager getWorkflowManager()
          Gets the WorkflowManager for this context
 boolean inTransaction()
          Return true if in a transaction, or false otherwise
 void rollback()
          Rollback transaction.
 void startTransaction()
          Start a transaction.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getCurrencies

java.util.List<com.ibm.icu.util.Currency> getCurrencies()
Gets all the currencies supported by the system.

Returns:
A List of Currency objects
Throws:
PIMInternalException - If an internal error occurs

getLocales

java.util.List<java.util.Locale> getLocales()
Gets all the locales supported by the system.

Returns:
A List of Locale objects
Throws:
PIMInternalException - If an internal error occurs

getCurrentUser

User getCurrentUser()
Returns the currently authenticated User object.

Returns:
A specific User object
Throws:
PIMInternalException - If an internal error occurs

getCatalogManager

CatalogManager getCatalogManager()
Gets the CatalogManager for this context

Returns:
the Manager for Catalog objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
CatalogManager

getAttributeCollectionManager

AttributeCollectionManager getAttributeCollectionManager()
Gets the AttributeCollectionManager for this context

Returns:
the Manager for AttributeCollection objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
AttributeCollectionManager

getHierarchyManager

HierarchyManager getHierarchyManager()
Gets the HierarchyManager for this context

Returns:
the Manager for Hierarchy objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
HierarchyManager

getLookupTableManager

LookupTableManager getLookupTableManager()
Gets the LookupTableManager for this context

Returns:
the Manager for LookupTable objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
LookupTableManager

createSearchQuery

SearchQuery createSearchQuery(java.lang.String queryString)
Obtain a Query object for the specified query String

Parameters:
queryString - String containing valid search query
Returns:
Return a Query object from which the query can be executed.
Throws:
PIMInternalException - if query is invalid (null string,empty string, wrong syntax,nonexisting container name etc)
PIMAuthorizationException - if the user is not authorized to perform this operation

getSpecManager

SpecManager getSpecManager()
Gets the SpecManager for this context

Returns:
the Manager for Spec objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
SpecManager

startTransaction

void startTransaction()
                      throws PIMAlreadyInTransactionException
Start a transaction. No effect if already in a transaction.

Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the user is not authorized to perform this operation
PIMAlreadyInTransactionException - if a transaction is already started. This situation must be handled; the user can commit, rollback or cancel their operation but should not continue normal processing if this is thrown, as subsequent code will think it is in a new transaction.

commit

void commit()
Commit transaction. No effect if not in a transaction.

Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the user is not authorized to perform this operation

rollback

void rollback()
Rollback transaction. No effect if not in a transaction.

Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the user is not authorized to perform this operation

inTransaction

boolean inTransaction()
Return true if in a transaction, or false otherwise

Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - if the user is not authorized to perform this operation

getTimezoneResolver

TimezoneResolver getTimezoneResolver()
Gets a utility for processing timezone related information.

Returns:
a TimezoneResolver
Throws:
PIMInternalException - if an internal error occurs

getDocstoreManager

DocstoreManager getDocstoreManager()
Gets the DocstoreManager for this context

Returns:
the Manager for Document and Directory objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
DocstoreManager

getPIMScriptManager

PIMScriptManager getPIMScriptManager()
Gets the PIMScriptManager for this context

Returns:
the Manager for PIMScript objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
PIMScriptManager

getWorkflowManager

WorkflowManager getWorkflowManager()
Gets the WorkflowManager for this context

Returns:
the Manager for Workflow objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
WorkflowManager

getCollaborationAreaManager

CollaborationAreaManager getCollaborationAreaManager()
Gets the CollaborationAreaManager for this context

Returns:
the Manager for CollaborationArea objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
CollaborationAreaManager

getIISIntegration

IISIntegration getIISIntegration()
Returns object of IISIntegration

Returns:
IISIntegration

getJobManager

JobManager getJobManager()
Obtain a new JobManager object.

Returns:
Return a JobManager object.
Throws:
PIMInternalException - if an internal exception occurs
PIMAuthorizationException - if the user is not authorized to perform this operation

getOrganizationManager

OrganizationManager getOrganizationManager()
Gets the OrganizationManager for this context

Returns:
the Manager for AccessControlGroup, Role and User objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
OrganizationManager

getAttributePathHelper

AttributePathHelper getAttributePathHelper()
Returns:
the Attribute Path Helper

getWebServiceManager

WebServiceManager getWebServiceManager()
Gets the WebServiceManager for this context

Returns:
Return a WebServiceManager object.
Throws:
PIMInternalException - if an internal exception occurs

getSelectionManager

SelectionManager getSelectionManager()
Gets the SelectionManager for this context

Returns:
the Manager for Selection objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
SelectionManager

getRoutingManager

RoutingManager getRoutingManager()
Gets the Routing manager for this context

Returns:
the Manager for Selection objects
Throws:
PIMInternalException - if an internal error occurs
See Also:
SelectionManager

getAdminHelper

AdminHelper getAdminHelper()
Returns object of AdminHelper

Returns:
AdminHelper object
Throws:
PIMInternalException - if an internal error occurs

getUIHelper

UIHelper getUIHelper()
Returns object of UIHelper

Returns:
UIHelper object

getEnvironmentExporter

EnvironmentExporter getEnvironmentExporter()
Gets the EnvironmentExporter for this context

Returns:
the EnvironmentExporter object for Exporting Environment
Throws:
PIMInternalException - if an internal error occurs

getEnvironmentImporter

EnvironmentImporter getEnvironmentImporter()
Gets the EnvironmentImporter for this context

Returns:
the EnvironmentImporter object for importing Environment
Throws:
PIMInternalException - if an internal error occurs

getDefaultLogger

Logger getDefaultLogger()
Returns an instance of root Logger as defined in configuration file /etc/default/api_log.xml

Returns:
root Logger Instance
Throws:
PIMInternalException - If an internal exception occurs.

getLogger

Logger getLogger(java.lang.String loggerName)
Returns an instance of Logger as defined in configuration file /etc/default/api_log.xml

Parameters:
loggerName - Name of the Logger instance as defined in configuration file.
Returns:
the Logger Instance

cleanUp

void cleanUp()
Clean up the resources that are used in the context.

Notes: call this method will release all resources used in the current context. It is recommend to call this method at the end of a web service implementation.

Throws:
PIMInternalException - If an internal error occurs