lumis.portal.serviceinstance
Class ServiceInstanceConfig

java.lang.Object
  lumis.portal.structure.StructureElement
      lumis.portal.serviceinstance.ServiceInstanceConfig

All Implemented Interfaces:

Cloneable, ICacheEntry, ICloneableCacheEntry, ICloneableConfig<ServiceInstanceConfig>

@StableMinor(version="6.2",
             sinceVersion="4.0")
public class ServiceInstanceConfig
extends StructureElement
implements ICloneableConfig<ServiceInstanceConfig>, ICloneableCacheEntry

Since:

4.0.0

Constructor Summary

ServiceInstanceConfig()

Method Summary

ServiceInstanceConfig	clone()
void	deserialize(Node serviceInstanceNode)
String	getAccessControlListId()
String	getChannelId()
String	getDescription()
Enumeration	getExtendedProperties(String name)
String	getExtendedProperty(String name)
Enumeration	getExtendedPropertyNames()
String	getFriendlyId() Returns the service instance's friendly identifier.
String	getId()
protected Pattern	getManagedPropertiesPattern() Returns the property name spaces.
String	getName()
Enumeration	getProperties(String name)
String	getProperty(String name)
String	getPropertyBagId() Returns the property bag identifier.
Enumeration	getPropertyNames()
String	getRestShortName() Returns the Rest shortName.
String	getServiceId()
boolean	getUsesFileTransformation() Returns the usesFileTransformation.
boolean	getUsesPublicFileStorage()
boolean	isAutomaticFriendlyId() Returns whether the service instance is going to use automatic generated friendly identifier or not.
boolean	isInContextEditDisabled()
boolean	isRestEnabled() Returns the restEnabled.
protected boolean	mayUseFriendlyId(String friendlyId) Indicates if the element may use the given friendly identifier.
void	serialize(SessionConfig sessionConfig, OutputStream outputStream, ITransaction transaction)
void	setAccessControlListId(String accessControlListId)
void	setAutoGeneratedFriendlyId() Generates a new friendly identifier and sets it as the friendly identifier of this service instance.
void	setAutomaticFriendlyId(boolean automaticFriendlyId) Indicates whether the service instance is going to use automatic generated friendly identifier or not.
void	setChannelId(String channelId)
void	setDescription(String description)
void	setDisableInContextEdit(boolean disableInContextEdit)
void	setFriendlyId(String friendlyId) Sets the service instance's friendly identifier.
void	setId(String id)
void	setName(String name)
void	setRestEnabled(boolean restEnabled) Sets the restEnabled.
void	setRestShortName(String shortName) Sets the shortName.
void	setServiceId(String serviceId)
void	setUsesFileTransformation(boolean usesFileTransformation) Sets the usesFileTransformation.
void	setUsesPublicFileStorage(boolean filePublic)

Methods inherited from class lumis.portal.structure.StructureElement

applyPropertyBagChanges, getAutomaticFriendlyId, getFriendlyIdBaseValue, getFriendlyIdMaxLength, getFriendlyIdValueForCounter, getPropertyValue, isManagedProperty, loadPropertyBagValues, removeProperty, serializePropertyBag, setPropertyValue, stripAccents

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceInstanceConfig

public ServiceInstanceConfig()

Method Detail

getDescription

public String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(String description)

Parameters:

description - The description to set.

getId

public String getId()

Returns:

Returns the id.

setId

public void setId(String id)

Parameters:

id - The id to set.

getName

public String getName()

Returns:

Returns the name.

setName

public void setName(String name)

Parameters:

name - The name to set.

getChannelId

public String getChannelId()

Returns:

Returns the channelId.

setChannelId

public void setChannelId(String channelId)

Parameters:

channelId - The channelId to set.

getServiceId

public String getServiceId()

Returns:

Returns the serviceId.

setServiceId

public void setServiceId(String serviceId)

Parameters:

serviceId - The serviceId to set.

getUsesPublicFileStorage

public boolean getUsesPublicFileStorage()

setUsesPublicFileStorage

public void setUsesPublicFileStorage(boolean filePublic)

isInContextEditDisabled

public boolean isInContextEditDisabled()

setDisableInContextEdit

public void setDisableInContextEdit(boolean disableInContextEdit)

getProperty

public String getProperty(String name)

getProperties

public Enumeration getProperties(String name)

getPropertyNames

public Enumeration getPropertyNames()

getExtendedProperty

public String getExtendedProperty(String name)

getExtendedProperties

public Enumeration getExtendedProperties(String name)

getExtendedPropertyNames

public Enumeration getExtendedPropertyNames()

getAccessControlListId

public String getAccessControlListId()

setAccessControlListId

public void setAccessControlListId(String accessControlListId)

setUsesFileTransformation

public void setUsesFileTransformation(boolean usesFileTransformation)

Sets the usesFileTransformation.

Parameters:

usesFileTransformation - the usesFileTransformation value to set.

Since:

6.1.0

getUsesFileTransformation

public boolean getUsesFileTransformation()

Returns the usesFileTransformation.

Returns:

the usesFileTransformation

Since:

6.1.0

setFriendlyId

public void setFriendlyId(String friendlyId)

Sets the service instance's friendly identifier. This value must be unique among the service instances contained in the same channel this service instance is contained.

Parameters:

friendlyId - the service instance's friendly identifier.

Since:

6.0.0

setAutoGeneratedFriendlyId

public void setAutoGeneratedFriendlyId()

Generates a new friendly identifier and sets it as the friendly identifier of this service instance. The friendly identifier is generated based on this service instance's current name.

This method requires an active transaction.

Since:

6.0.0

See Also:

setFriendlyId(String)

getFriendlyId

public String getFriendlyId()

Returns the service instance's friendly identifier.

Returns:

the service instance's friendly identifier.

Since:

6.0.0

setAutomaticFriendlyId

public void setAutomaticFriendlyId(boolean automaticFriendlyId)

Indicates whether the service instance is going to use automatic generated friendly identifier or not.

Parameters:

automaticFriendlyId - indicates whether the service instance is going to use automatic generated friendly identifier or not.

Since:

6.0.0

isAutomaticFriendlyId

public boolean isAutomaticFriendlyId()

Returns whether the service instance is going to use automatic generated friendly identifier or not.

Returns:

whether the service instance is going to use automatic generated friendly identifier or not.

Since:

6.0.0

serialize

public void serialize(SessionConfig sessionConfig,
                      OutputStream outputStream,
                      ITransaction transaction)
               throws PortalException

Throws:

PortalException

deserialize

public void deserialize(Node serviceInstanceNode)
                 throws PortalException

Throws:

PortalException

clone

public ServiceInstanceConfig clone()
                            throws CloneNotSupportedException

Specified by:

clone in interface ICloneableCacheEntry

Specified by:

clone in interface ICloneableConfig<ServiceInstanceConfig>

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getManagedPropertiesPattern

protected Pattern getManagedPropertiesPattern()

Description copied from class: StructureElement

Returns the property name spaces. Used to decides if a property can be updated.

Specified by:

getManagedPropertiesPattern in class StructureElement

Returns:

property name spaces

getPropertyBagId

public String getPropertyBagId()

Description copied from class: StructureElement

Returns the property bag identifier.

Specified by:

getPropertyBagId in class StructureElement

Returns:

The propertyBagId.

mayUseFriendlyId

protected boolean mayUseFriendlyId(String friendlyId)
                            throws PortalException

Description copied from class: StructureElement

Indicates if the element may use the given friendly identifier.

Specified by:

mayUseFriendlyId in class StructureElement

Parameters:

friendlyId - the friendly identifier.

Returns:

true if the element may use the given friendly identifier, false otherwise.

Throws:

PortalException

setRestShortName

public void setRestShortName(String shortName)

Sets the shortName.

Parameters:

shortName - the shortName value to set.

Since:

6.1.0

getRestShortName

public String getRestShortName()

Returns the Rest shortName.

Returns:

the shortName

Since:

6.1.0

setRestEnabled

public void setRestEnabled(boolean restEnabled)

Sets the restEnabled.

Parameters:

restEnabled - the restEnabled value to set.

Since:

6.1.0

isRestEnabled

public boolean isRestEnabled()

Returns the restEnabled.

Returns:

the restEnabled

Since:

6.1.0