|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="4.1", sinceVersion="4.0") public interface IServiceInterfaceInstanceManager
Interface definition for manager of service interface instances.
Method Summary | |
---|---|
String |
add(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
ITransaction transaction)
Add a service interface instance. |
void |
addOrUpdate(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
ITransaction transaction)
Add or Update a Service Interface Instance, depending on its previous existence. |
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 |
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. |
Method Detail |
---|
void addOrUpdate(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceConfig
- transaction
-
ManagerException
PortalException
ServiceInterfaceInstanceConfig get(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
String add(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceConfig
- transaction
-
ManagerException
PortalException
void update(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceConfig
- transaction
-
ManagerException
PortalException
void delete(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
String copy(SessionConfig sessionConfig, String sourceServiceInterfaceInstanceId, String destinationPageId, boolean destinationInterfaceInstanceIsFromTemplate, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- sourceServiceInterfaceInstanceId
- destinationPageId
- transaction
-
ManagerException
PortalException
ServiceInterfaceInstanceConfig getOrAddServiceInterfaceRunTimeInstance(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceId
- serviceInstanceId
- pageId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, boolean includeRunTimeInterfaces, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- includeRunTimeInterfaces
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceId
- serviceInstanceId
- ignoreRuntimeInterfaces
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceId
- serviceInstanceId
- ignoreRuntimeInterfaces
- ignorePageTemplates
- TODOtransaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInterfaceId(SessionConfig sessionConfig, String serviceInterfaceId, boolean ignoreRuntimeInterfaces, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceId
- ignoreRuntimeInterfaces
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInterfaceId(SessionConfig sessionConfig, String serviceInterfaceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceId
- ignoreRuntimeInterfaces
- ignorePageTemplates
- TODOtransaction
-
ManagerException
PortalException
Collection<String> getIdsByPageId(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInterfaceStyleId(SessionConfig sessionConfig, String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceStyleId
- serviceInterfaceId
- transaction
-
ManagerException
PortalException
void setCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, String value, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- interfaceInstanceId
- name
- value
- transaction
-
ManagerException
PortalException
void setCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, Map<String,String> propertiesTable, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- interfaceInstanceId
- propertiesTable
- transaction
-
ManagerException
PortalException
String getCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- interfaceInstanceId
- name
- transaction
-
ManagerException
PortalException
Map<String,String> getCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- the user session information.interfaceInstanceId
- the service interface instance id.transaction
- the transaction for persistence access.
ManagerException
PortalException
String getMenu(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
String getXmlData(SessionConfig sessionConfig, String serviceInterfaceInstanceId) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
void deleteCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- interfaceInstanceId
- name
- transaction
-
ManagerException
PortalException
void deleteCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- interfaceInstanceId
- transaction
-
ManagerException
PortalException
void updateCustomPropertiesFromTemplate(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- interfaceInstanceId
- transaction
-
ManagerException
PortalException
boolean getPrintable(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
int getRenderAs(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
boolean getEnableCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
int getCacheLevel(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
int getCachePersonalization(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
boolean getCacheServerSideInclude(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- transaction
-
ManagerException
PortalException
void serialize(SessionConfig sessionConfig, String serviceInterfaceInstanceId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- outputStream
- transaction
-
ManagerException
PortalException
String deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInterfaceInstanceNode, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- deserializationConfig
- serviceInterfaceInstanceNode
- transaction
-
ManagerException
PortalException
void serializeCustomProperties(SessionConfig sessionConfig, String serviceInterfaceInstanceId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- outputStream
- transaction
-
ManagerException
PortalException
void deserializeCustomProperties(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInterfaceInstanceCustomPropertiesNode, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- deserializationConfig
- serviceInterfaceInstanceCustomPropertiesNode
- transaction
-
ManagerException
PortalException
void clearCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
Clears service interface instance related information, cached in this manager, including HTML cache, and its XSL cache.
sessionConfig
- the user session information.serviceInterfaceInstanceId
- the service interface instance identifier.transaction
- the transaction for persistence access.
ManagerException
PortalException
void clearCache(ITransaction transaction) throws PortalException
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
void setInterfaceInstanceHtmlCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Locale locale, String serviceInterfaceInstanceHtml, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- locale
- serviceInterfaceInstanceHtml
- transaction
-
ManagerException
PortalException
String getInterfaceInstanceHtmlCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Locale locale, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInterfaceInstanceId
- locale
- transaction
-
ManagerException
PortalException
void updatePropertiesFromTemplate(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- interfaceInstanceId
- transaction
-
ManagerException
PortalException
IConfigKeyChecker getServiceInterfaceInstanceStyleConfigKeyChecker()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |