|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lumis.portal.serviceinterfaceinstance.ServiceInterfaceInstanceManager
public class ServiceInterfaceInstanceManager
Class responsible for operations with Service Interface Instances
Constructor Summary | |
---|---|
ServiceInterfaceInstanceManager()
|
Method Summary | |
---|---|
String |
add(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
ITransaction transaction)
Add a service interface instance. |
protected void |
addGenericMenuItemToMenu(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
Node itemNode,
StringBuilder menu,
IServiceInterfaceManager serviceInterfaceManager,
ITransaction transaction)
|
protected void |
addGroupItemToMenu(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
Node groupNode,
StringBuilder menu,
IServiceInterfaceManager serviceInterfaceManager,
ITransaction transaction)
|
protected String |
addMenuItemToMenu(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
Node itemNode,
IServiceInterfaceManager serviceInterfaceManager,
ITransaction transaction)
|
void |
addOrUpdate(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
ITransaction transaction)
Service Interface Instance |
void |
clearCache(ITransaction transaction)
Clears all cache stored in this manager. |
void |
clearCache(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Clears the caches of a service interface instance. |
String |
copy(SessionConfig sessionConfig,
String sourceServiceInterfaceInstanceId,
String destinationPageId,
boolean destinationInterfaceInstanceIsFromTemplate,
ITransaction transaction)
Creates a copy of the given interface instance to the specified page. |
void |
delete(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Delete a service interface instance. |
void |
deleteCustomProperties(SessionConfig sessionConfig,
String interfaceInstanceId,
ITransaction transaction)
Deletes all the interface instance custom properties |
void |
deleteCustomProperty(SessionConfig sessionConfig,
String interfaceInstanceId,
String name,
ITransaction transaction)
Deletes the interface instance custom property |
protected void |
deleteServiceInterfaceInstance_Internal(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction daoTransaction)
|
String |
deserialize(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node serviceInterfaceInstanceNode,
ITransaction transaction)
|
void |
deserializeCustomProperties(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node serviceInterfaceInstanceCustomPropertiesNode,
ITransaction transaction)
|
ServiceInterfaceInstanceConfig |
get(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Get the configuration of the service interface instance. |
int |
getCacheLevel(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Returns the cacheLevel property of an interface instance. |
int |
getCachePersonalization(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Returns the cachePersonalization property of an interface instance. |
boolean |
getCacheServerSideInclude(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Returns the cacheServerSideInclude property of an interface instance. |
Map<String,String> |
getCustomProperties(SessionConfig sessionConfig,
String interfaceInstanceId,
ITransaction transaction)
Returns a Map containing all name/value pairs of custom properties from the specified service interface instance. |
String |
getCustomProperty(SessionConfig sessionConfig,
String interfaceInstanceId,
String name,
ITransaction transaction)
Returns the specified custom property. |
boolean |
getEnableCache(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Returns the enableCache property of an interface instance. |
Collection<String> |
getIdsByPageId(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Get a list of ids by passing the page's id. |
Collection<String> |
getIdsByServiceInstanceId(SessionConfig sessionConfig,
String serviceInstanceId,
boolean includeRunTimeInterfaces,
ITransaction transaction)
Get the Ids given the ServiceInstanceId. |
Collection<String> |
getIdsByServiceInstanceId(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Get a list of ids by passing the id of the service instance. |
Collection<String> |
getIdsByServiceInterfaceId(SessionConfig sessionConfig,
String serviceInterfaceId,
boolean ignoreRuntimeInterfaces,
boolean ignorePageTemplates,
ITransaction transaction)
Get a list of ids by passing the ids of the service interface. |
Collection<String> |
getIdsByServiceInterfaceId(SessionConfig sessionConfig,
String serviceInterfaceId,
boolean ignoreRuntimeInterfaces,
ITransaction transaction)
Get a list of ids by passing the ids of the service interface. |
Collection<String> |
getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig,
String serviceInterfaceId,
String serviceInstanceId,
boolean ignoreRuntimeInterfaces,
boolean ignorePageTemplates,
ITransaction transaction)
Get a list of ids by passing the ids of service interface and the service instance. |
Collection<String> |
getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig,
String serviceInterfaceId,
String serviceInstanceId,
boolean ignoreRuntimeInterfaces,
ITransaction transaction)
Get a list of ids by passing the ids of service interface and the service instance. |
Collection<String> |
getIdsByServiceInterfaceStyleId(SessionConfig sessionConfig,
String serviceInterfaceStyleId,
String serviceInterfaceId,
ITransaction transaction)
Get the Ids given the ServiceInterfaceStyleId. |
String |
getInterfaceInstanceHtmlCache(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
Locale locale,
ITransaction transaction)
Get the HTML Cache of the Interface Instance. |
String |
getMenu(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Returns the XML for the administration menu of the specified interface instance |
ServiceInterfaceInstanceConfig |
getOrAddServiceInterfaceRunTimeInstance(SessionConfig sessionConfig,
String serviceInterfaceId,
String serviceInstanceId,
String pageId,
ITransaction transaction)
Get or Add the ServiceInterfaceRunTimeInstance. |
boolean |
getPrintable(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Returns the printable property of an interface instance. |
int |
getRenderAs(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
ITransaction transaction)
Returns the renderAs property of an interface instance. |
IConfigKeyChecker |
getServiceInterfaceInstanceStyleConfigKeyChecker()
|
String |
getXmlData(SessionConfig sessionConfig,
String serviceInterfaceInstanceId)
Returns the previously saved XML data for the service interface instance for the given user session |
void |
serialize(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
OutputStream outputStream,
ITransaction transaction)
|
void |
serializeCustomProperties(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
OutputStream outputStream,
ITransaction transaction)
|
void |
setCustomProperties(SessionConfig sessionConfig,
String interfaceInstanceId,
Map<String,String> propertiesTable,
ITransaction transaction)
Receives a Map with one or more properties to be set for the given interface. |
void |
setCustomProperty(SessionConfig sessionConfig,
String interfaceInstanceId,
String name,
String value,
ITransaction transaction)
Set a custom property for the given interface instance. |
void |
setInterfaceInstanceHtmlCache(SessionConfig sessionConfig,
String serviceInterfaceInstanceId,
Locale locale,
String serviceInterfaceInstanceHtml,
ITransaction transaction)
Get the HTML Cache of the Interface Instance. |
void |
update(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
ITransaction transaction)
Update a service interface instance. |
void |
updateCustomPropertiesFromTemplate(SessionConfig sessionConfig,
String interfaceInstanceId,
ITransaction transaction)
Update the interface instance custom properties from parent interface instance |
void |
updatePropertiesFromTemplate(SessionConfig sessionConfig,
String interfaceInstanceId,
ITransaction transaction)
Update the properties of from the template. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ServiceInterfaceInstanceManager()
Method Detail |
---|
public void addOrUpdate(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
addOrUpdate
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public ServiceInterfaceInstanceConfig get(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
get
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public String add(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
add
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void update(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
update
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void delete(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
delete
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public String copy(SessionConfig sessionConfig, String sourceServiceInterfaceInstanceId, String destinationPageId, boolean destinationInterfaceInstanceIsFromTemplate, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
copy
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public ServiceInterfaceInstanceConfig getOrAddServiceInterfaceRunTimeInstance(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, String pageId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getOrAddServiceInterfaceRunTimeInstance
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
protected void deleteServiceInterfaceInstance_Internal(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction daoTransaction) throws ManagerException, PortalException
ManagerException
PortalException
public Collection<String> getIdsByServiceInterfaceId(SessionConfig sessionConfig, String serviceInterfaceId, boolean ignoreRuntimeInterfaces, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByServiceInterfaceId
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public Collection<String> getIdsByServiceInterfaceId(SessionConfig sessionConfig, String serviceInterfaceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByServiceInterfaceId
in interface IServiceInterfaceInstanceManager
ignorePageTemplates
- TODO
ManagerException
PortalException
public Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByServiceInstanceId
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, boolean includeRunTimeInterfaces, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByServiceInstanceId
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public Collection<String> getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByServiceInterfaceIdAndServiceInstanceId
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public Collection<String> getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByServiceInterfaceIdAndServiceInstanceId
in interface IServiceInterfaceInstanceManager
ignorePageTemplates
- TODO
ManagerException
PortalException
public Collection<String> getIdsByPageId(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByPageId
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public Collection<String> getIdsByServiceInterfaceStyleId(SessionConfig sessionConfig, String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getIdsByServiceInterfaceStyleId
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public String getCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getCustomProperty
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public Map<String,String> getCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getCustomProperties
in interface IServiceInterfaceInstanceManager
sessionConfig
- the user session information.interfaceInstanceId
- the service interface instance id.transaction
- the transaction for persistence access.
ManagerException
PortalException
public void setCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, String value, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
setCustomProperty
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void setCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, Map<String,String> propertiesTable, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
setCustomProperties
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void deleteCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
deleteCustomProperty
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void deleteCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
deleteCustomProperties
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public String getMenu(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getMenu
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
protected void addGenericMenuItemToMenu(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Node itemNode, StringBuilder menu, IServiceInterfaceManager serviceInterfaceManager, ITransaction transaction) throws ManagerException, PortalException
ManagerException
PortalException
protected String addMenuItemToMenu(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Node itemNode, IServiceInterfaceManager serviceInterfaceManager, ITransaction transaction) throws ManagerException, PortalException
ManagerException
PortalException
protected void addGroupItemToMenu(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Node groupNode, StringBuilder menu, IServiceInterfaceManager serviceInterfaceManager, ITransaction transaction) throws ManagerException, PortalException
ManagerException
PortalException
public void updateCustomPropertiesFromTemplate(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
updateCustomPropertiesFromTemplate
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public String getXmlData(SessionConfig sessionConfig, String serviceInterfaceInstanceId) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getXmlData
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public boolean getPrintable(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getPrintable
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public int getRenderAs(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getRenderAs
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public boolean getEnableCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getEnableCache
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public int getCacheLevel(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getCacheLevel
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public int getCachePersonalization(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getCachePersonalization
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public boolean getCacheServerSideInclude(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getCacheServerSideInclude
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void serialize(SessionConfig sessionConfig, String serviceInterfaceInstanceId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
serialize
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public String deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInterfaceInstanceNode, ITransaction transaction) throws ManagerException, PortalException
deserialize
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void serializeCustomProperties(SessionConfig sessionConfig, String serviceInterfaceInstanceId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
serializeCustomProperties
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void deserializeCustomProperties(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInterfaceInstanceCustomPropertiesNode, ITransaction transaction) throws ManagerException, PortalException
deserializeCustomProperties
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void clearCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
Clears service interface instance related information, cached in this manager, including HTML cache, and its XSL cache.
clearCache
in interface IServiceInterfaceInstanceManager
sessionConfig
- the user session information.serviceInterfaceInstanceId
- the service interface instance identifier.transaction
- the transaction for persistence access.
ManagerException
PortalException
public void clearCache(ITransaction transaction) throws PortalException
IServiceInterfaceInstanceManager
clearCache
in interface IServiceInterfaceInstanceManager
transaction
- the transaction for persistence access. If null,
the cache is just cleared, else it is cleared as a transactional
operation as specified in PortalCache.clear(ITransaction)
.
PortalException
public void setInterfaceInstanceHtmlCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Locale locale, String serviceInterfaceInstanceHtml, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
setInterfaceInstanceHtmlCache
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public String getInterfaceInstanceHtmlCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Locale locale, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
getInterfaceInstanceHtmlCache
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public void updatePropertiesFromTemplate(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
IServiceInterfaceInstanceManager
updatePropertiesFromTemplate
in interface IServiceInterfaceInstanceManager
ManagerException
PortalException
public IConfigKeyChecker getServiceInterfaceInstanceStyleConfigKeyChecker()
getServiceInterfaceInstanceStyleConfigKeyChecker
in interface IServiceInterfaceInstanceManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |