lumis.portal.structure.sync.model.serviceinstance
Class ServiceInstance

java.lang.Object
  lumis.portal.structure.sync.model.serviceinstance.ServiceInstance

All Implemented Interfaces:

Cloneable, ICustomEquivalence, IFileElement, IFileStructureElement

public class ServiceInstance
extends Object
implements IFileStructureElement, Cloneable, ICustomEquivalence

Service instance model.

Documentation in this class focus synchronization behavior. About the use behind the fields in the portal, see ServiceInstanceConfig.

Since:

6.2.0

See Also:

ServiceInstanceConfig

Constructor Summary

ServiceInstance()

Method Summary

void	adjustChannelTemplateLink(Queue<ParallelExecutor.IDatabaseTask> channelTemplateLinksToAdd)
void	afterXmlRead()
void	beforeXmlWrite() Before XML write callback.
protected Object	clone()
AccessControlList	getAccessControlList() Returns the accessControlList.
String	getChannelId()
SortedSet<ServiceInstanceCustomProperty>	getCustomProperties() Returns the customProperties.
SortedSet<ServiceInstanceDependency>	getDependencies() Returns the dependencies.
String	getDescription() Returns the description.
String	getDirectoryChannelId() Returns the identifier of the channel that corresponds to the directory this element's file resides in.
Set<FileTransformation>	getFileTransformations()
String	getId() Returns the element's identifier.
String	getName() Returns the name.
PropertyBag	getPropertyBag()
String	getServiceId() Returns the serviceId.
String	getStructureFileName() Returns the name of the structure file for this element.
boolean	isEquivalent(Object obj) Returns whether this object is equivalent to the given object.
boolean	isImplicitForeignKeysSet() Indicates whether the implicit foreign keys, set by #setImplicitForeignKeys(String, String), have been set.
boolean	isUsesPublicFileStorage() Returns the usesPublicFileStorage.
void	setChannelId(String channelId)
void	setFriendlyId(String friendlyId) Sets the friendly identifier for this structure element.
void	setImplicitForeignKeys(String accessControlListId, String parentAccessControlListId, String propertyBagId, String parentPropertyBagId) Sets the implicit foreign keys in this service instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceInstance

public ServiceInstance()

Method Detail

getName

public String getName()

Returns the name.

Returns:

the name

Since:

6.2.0

getDescription

public String getDescription()

Returns the description.

Returns:

the description

Since:

6.2.0

getServiceId

public String getServiceId()

Returns the serviceId.

Returns:

the serviceId

Since:

6.2.0

getAccessControlList

public AccessControlList getAccessControlList()

Returns the accessControlList.

Returns:

the accessControlList

Since:

6.2.0

isUsesPublicFileStorage

public boolean isUsesPublicFileStorage()

Returns the usesPublicFileStorage.

Returns:

the usesPublicFileStorage

Since:

6.2.0

getCustomProperties

public SortedSet<ServiceInstanceCustomProperty> getCustomProperties()

Returns the customProperties.

Returns:

the customProperties

Since:

6.2.0

getFileTransformations

public Set<FileTransformation> getFileTransformations()

getDependencies

public SortedSet<ServiceInstanceDependency> getDependencies()

Returns the dependencies.

Returns:

the dependencies

Since:

6.2.0

isImplicitForeignKeysSet

public boolean isImplicitForeignKeysSet()

Indicates whether the implicit foreign keys, set by #setImplicitForeignKeys(String, String), have been set.

Returns:

true if the implicit foreign keys are set, false otherwise.

Since:

6.2.0

setImplicitForeignKeys

public void setImplicitForeignKeys(String accessControlListId,
                                   String parentAccessControlListId,
                                   String propertyBagId,
                                   String parentPropertyBagId)

Sets the implicit foreign keys in this service instance. Required before it can be properly persisted to the database.

Parameters:

accessControlListId - the identifier for this service instance's ACL. Must be null if the service instance will be added (will be auto-generated).

parentAccessControlListId - the identifier of the parent of this service instance's ACL.

propertyBagId - the identifier of the property bag.

parentPropertyBagId - the identifier of the parent property bag.

Since:

6.2.0

getId

public String getId()

Description copied from interface: IFileStructureElement

Returns the element's identifier.

Specified by:

getId in interface IFileStructureElement

Returns:

the element's identifier.

getDirectoryChannelId

public String getDirectoryChannelId()

Description copied from interface: IFileStructureElement

Returns the identifier of the channel that corresponds to the directory this element's file resides in.

Specified by:

getDirectoryChannelId in interface IFileStructureElement

Returns:

the identifier of the channel.

getStructureFileName

public String getStructureFileName()

Description copied from interface: IFileStructureElement

Returns the name of the structure file for this element.

Specified by:

getStructureFileName in interface IFileStructureElement

Returns:

the structure file name (only the file's name, does not include any path).

setChannelId

public void setChannelId(String channelId)

getChannelId

public String getChannelId()

setFriendlyId

public void setFriendlyId(String friendlyId)

Description copied from interface: IFileStructureElement

Sets the friendly identifier for this structure element.

Specified by:

setFriendlyId in interface IFileStructureElement

Parameters:

friendlyId - the friendly identifier.

getPropertyBag

public PropertyBag getPropertyBag()

afterXmlRead

public void afterXmlRead()

beforeXmlWrite

public void beforeXmlWrite()

Before XML write callback.

Since:

6.2.0

clone

protected Object clone()

Overrides:

clone in class Object

adjustChannelTemplateLink

public void adjustChannelTemplateLink(Queue<ParallelExecutor.IDatabaseTask> channelTemplateLinksToAdd)

Parameters:

channelTemplateLinksToAdd -

Since:

6.2.0

isEquivalent

public boolean isEquivalent(Object obj)

Description copied from interface: ICustomEquivalence

Returns whether this object is equivalent to the given object. If the object is equivalent, it will not need to be updated during synchronization.

Specified by:

isEquivalent in interface ICustomEquivalence

Parameters:

obj - the object to compare with.

Returns:

true if the objects are equivalent, false otherwise.