Package lumis.portal.serviceinterface.style

Class ServiceInterfaceStyleConfig

java.lang.Object

lumis.portal.serviceinterface.style.ServiceInterfaceStyleConfig

All Implemented Interfaces:

java.lang.Cloneable, ICloneableConfig<ServiceInterfaceStyleConfig>

@StableMinor(version="16.1",
             sinceVersion="4.0")
public class ServiceInterfaceStyleConfig
extends java.lang.Object
implements ICloneableConfig<ServiceInterfaceStyleConfig>

Value class for Service Interface Style properties

Since:

4.0.0

Version:

$Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceInterfaceStyleConfig.IsolationLevel	Represents the level of isolation of a Style.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	description
protected java.lang.String	filePath
protected java.lang.String	id
protected boolean	isFromDefinition
protected java.util.Collection<java.lang.String>	isolationAllowedConsumers
protected ServiceInterfaceStyleConfig.IsolationLevel	isolationLevel
protected boolean	isWidgetDefault
protected java.lang.String	name
protected java.lang.String	serviceInterfaceId

Constructor Summary

Constructors

Constructor	Description
ServiceInterfaceStyleConfig()

Method Summary

Modifier and Type	Method	Description
ServiceInterfaceStyleConfig	clone()
void	deserialize(org.w3c.dom.Node serviceInstanceNode)	Deserialize the properties of the ServiceInstanceStyleConfig from the specified XML Node.
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()
java.lang.String	getFilePath()
java.lang.String	getId()
java.util.Collection<java.lang.String>	getIsolationAllowedConsumers()	Returns a list of identifiers of elements that are allowed to use this style.
ServiceInterfaceStyleConfig.IsolationLevel	getIsolationLevel()	Returns the isolation level for this style.
boolean	getIsWidgetDefault()	Returns the isWidgetDefault.
java.lang.String	getName()
java.lang.String	getServiceInterfaceId()
int	hashCode()
boolean	isFromDefinition()
void	serialize(ServiceInterfaceStyleConfig styleConfig, java.io.OutputStream outputStream)	Serializes the interface style config to the specified output stream.
void	setDescription(java.lang.String description)
void	setFilePath(java.lang.String filePath)
void	setFromDefinition(boolean isFromDefinition)
void	setId(java.lang.String id)
void	setIsolation(ServiceInterfaceStyleConfig.IsolationLevel isolationLevel, java.util.Collection<java.lang.String> allowedConsumers)	Sets the isolationLevel.
void	setIsWidgetDefault(boolean isWidgetDefault)	Sets the isWidgetDefault.
void	setName(java.lang.String name)
void	setServiceInterfaceId(java.lang.String interfaceId)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected java.lang.String id

serviceInterfaceId

protected java.lang.String serviceInterfaceId

name

protected java.lang.String name

description

protected java.lang.String description

filePath

protected java.lang.String filePath

isFromDefinition

protected boolean isFromDefinition

isWidgetDefault

protected boolean isWidgetDefault

isolationAllowedConsumers

protected java.util.Collection<java.lang.String> isolationAllowedConsumers

isolationLevel

protected ServiceInterfaceStyleConfig.IsolationLevel isolationLevel

Constructor Detail

ServiceInterfaceStyleConfig

public ServiceInterfaceStyleConfig()

Method Detail

getDescription

public java.lang.String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The description to set.

getFilePath

public java.lang.String getFilePath()

Returns:

Returns the filePath.

setFilePath

public void setFilePath(java.lang.String filePath)

Parameters:

filePath - The filePath to set.

getId

public java.lang.String getId()

Returns:

Returns the id.

setId

public void setId(java.lang.String id)

Parameters:

id - The id to set.

getServiceInterfaceId

public java.lang.String getServiceInterfaceId()

Returns:

Returns the serviceInterfaceId.

setServiceInterfaceId

public void setServiceInterfaceId(java.lang.String interfaceId)

Parameters:

serviceInterfaceId - The serviceInterfaceId to set.

isFromDefinition

public boolean isFromDefinition()

Returns:

Returns the isFromDefinition.

setFromDefinition

public void setFromDefinition(boolean isFromDefinition)

Parameters:

isFromDefinition - The isFromDefinition to set.

getName

public java.lang.String getName()

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Parameters:

name - The name to set.

serialize

public void serialize(ServiceInterfaceStyleConfig styleConfig,
                      java.io.OutputStream outputStream)
               throws PortalException

Serializes the interface style config to the specified output stream.

Parameters:

pageConfig -

outputStream -

Throws:

PortalException

Since:

4.0.3

deserialize

public void deserialize(org.w3c.dom.Node serviceInstanceNode)
                 throws PortalException

Deserialize the properties of the ServiceInstanceStyleConfig from the specified XML Node.

Parameters:

serviceInstanceNode -

Throws:

PortalException

Since:

4.0.3

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public ServiceInterfaceStyleConfig clone()
                                  throws java.lang.CloneNotSupportedException

Specified by:

clone in interface ICloneableConfig<ServiceInterfaceStyleConfig>

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setIsWidgetDefault

public void setIsWidgetDefault(boolean isWidgetDefault)

Sets the isWidgetDefault.

Parameters:

isWidgetDefault - the isWidgetDefault value to set.

Since:

6.0.0

getIsWidgetDefault

public boolean getIsWidgetDefault()

Returns the isWidgetDefault.

Returns:

the isWidgetDefault

Since:

6.0.0

getIsolationLevel

public ServiceInterfaceStyleConfig.IsolationLevel getIsolationLevel()

Returns the isolation level for this style.

Returns:

the isolation level.

Since:

6.2.0

setIsolation

public void setIsolation(ServiceInterfaceStyleConfig.IsolationLevel isolationLevel,
                         java.util.Collection<java.lang.String> allowedConsumers)
                  throws IsolationLevelValidationException,
                         PortalException

Sets the isolationLevel. This method validates the rules of isolation. If any error of validation occurs an IsolationLevelValidationException is raised.

Parameters:

isolationLevel - the isolation level.

allowedConsumers - collection with the identifiers of the consumers allowed to use this style. If isolationLevel is ServiceInterfaceStyleConfig.IsolationLevel.ISOLATED, it must be a single interface instance identifier; If isolationLevel is ServiceInterfaceStyleConfig.IsolationLevel.SHARED, it must be the identifiers of the service instances that can use the style.

Throws:

IsolationLevelValidationException - if any rule of validation is invalid.

PortalException - if any error occurs during the process.

Since:

6.2.0

getIsolationAllowedConsumers

public java.util.Collection<java.lang.String> getIsolationAllowedConsumers()

Returns a list of identifiers of elements that are allowed to use this style.

If the isolation level is ServiceInterfaceStyleConfig.IsolationLevel.PUBLIC the returned collection is empty.

If the isolation level is ServiceInterfaceStyleConfig.IsolationLevel.ISOLATED the returned collection contains a single interface instance identifier.

If the isolation level is ServiceInterfaceStyleConfig.IsolationLevel.SHARED the returned collection contains the identifiers of service instances.

Returns:

the consumers identifiers, as explained above.

Since:

6.2.0