|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Context
Interface providing methods for Context
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 |
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 |
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
java.util.List<com.ibm.icu.util.Currency> getCurrencies()
PIMInternalException
- If an internal error occursjava.util.List<java.util.Locale> getLocales()
PIMInternalException
- If an internal error occursUser getCurrentUser()
PIMInternalException
- If an internal error occursCatalogManager getCatalogManager()
PIMInternalException
- if an internal error occursCatalogManager
AttributeCollectionManager getAttributeCollectionManager()
PIMInternalException
- if an internal error occursAttributeCollectionManager
HierarchyManager getHierarchyManager()
PIMInternalException
- if an internal error occursHierarchyManager
LookupTableManager getLookupTableManager()
PIMInternalException
- if an internal error occursLookupTableManager
SearchQuery createSearchQuery(java.lang.String queryString)
queryString
- String containing valid search query
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 operationSpecManager getSpecManager()
PIMInternalException
- if an internal error occursSpecManager
void startTransaction() throws PIMAlreadyInTransactionException
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.void commit()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the user is not authorized to perform this operationvoid rollback()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the user is not authorized to perform this operationboolean inTransaction()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the user is not authorized to perform this operationTimezoneResolver getTimezoneResolver()
PIMInternalException
- if an internal error occursDocstoreManager getDocstoreManager()
PIMInternalException
- if an internal error occursDocstoreManager
PIMScriptManager getPIMScriptManager()
PIMInternalException
- if an internal error occursPIMScriptManager
WorkflowManager getWorkflowManager()
PIMInternalException
- if an internal error occursWorkflowManager
CollaborationAreaManager getCollaborationAreaManager()
PIMInternalException
- if an internal error occursCollaborationAreaManager
IISIntegration getIISIntegration()
JobManager getJobManager()
PIMInternalException
- if an internal exception occurs
PIMAuthorizationException
- if the user is not authorized to perform this operationOrganizationManager getOrganizationManager()
PIMInternalException
- if an internal error occursOrganizationManager
AttributePathHelper getAttributePathHelper()
WebServiceManager getWebServiceManager()
PIMInternalException
- if an internal exception occursSelectionManager getSelectionManager()
PIMInternalException
- if an internal error occursSelectionManager
RoutingManager getRoutingManager()
PIMInternalException
- if an internal error occursSelectionManager
AdminHelper getAdminHelper()
PIMInternalException
- if an internal error occursUIHelper getUIHelper()
EnvironmentExporter getEnvironmentExporter()
PIMInternalException
- if an internal error occursEnvironmentImporter getEnvironmentImporter()
PIMInternalException
- if an internal error occursLogger getDefaultLogger()
PIMInternalException
- If an internal exception occurs.Logger getLogger(java.lang.String loggerName)
loggerName
- Name of the Logger instance as defined in configuration file.
void cleanUp()
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.
PIMInternalException
- If an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |