Class ServiceInstance
- java.lang.Object
-
- lumis.portal.structure.sync.model.serviceinstance.ServiceInstance
-
- All Implemented Interfaces:
java.lang.Cloneable
,ICustomEquivalence
,IFileElement
,IFileStructureElement
public class ServiceInstance extends java.lang.Object implements IFileStructureElement, java.lang.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
- Version:
- $Revision: 25303 $ $Date: 2022-10-22 22:48:02 -0300 (Sat, 22 Oct 2022) $
- See Also:
ServiceInstanceConfig
-
-
Constructor Summary
Constructors Constructor Description ServiceInstance()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
adjustChannelTemplateLink(java.util.Queue<ParallelExecutor.IDatabaseTask> channelTemplateLinksToAdd)
protected java.lang.Object
clone()
AccessControlList
getAccessControlList()
Returns the accessControlList.java.lang.String
getChannelId()
java.util.SortedSet<ServiceInstanceCustomProperty>
getCustomProperties()
Returns the customProperties.java.util.SortedSet<ServiceInstanceDependency>
getDependencies()
Returns the dependencies.java.lang.String
getDescription()
Returns the description.java.lang.String
getDirectoryChannelId()
Returns the identifier of the channel that corresponds to the directory this element's file resides in.java.util.Set<FileTransformation>
getFileTransformations()
java.lang.String
getId()
Returns the element's identifier.java.lang.String
getName()
Returns the name.PropertyBag
getPropertyBag()
java.lang.String
getServiceId()
Returns the serviceId.java.lang.String
getStructureFileName()
Returns the name of the structure file for this element.java.lang.String
getWorkflowId()
Returns the workflow identifier.java.util.Set<ServiceInstanceWorkflowPermissionXml>
getWorkflowPermissions()
Returns the set of permissions for the XML serialization.boolean
isEquivalent(java.lang.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(java.lang.String channelId)
void
setFriendlyId(java.lang.String friendlyId)
Sets the friendly identifier for this structure element.void
setImplicitForeignKeys(java.lang.String accessControlListId, java.lang.String parentAccessControlListId, java.lang.String propertyBagId, java.lang.String parentPropertyBagId)
Sets the implicit foreign keys in this service instance.void
setWorkflow(ServiceInstanceWorkflow workflow)
Sets the workflow identifier.
-
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the name.- Returns:
- the name
- Since:
- 6.2.0
-
getDescription
public java.lang.String getDescription()
Returns the description.- Returns:
- the description
- Since:
- 6.2.0
-
getServiceId
public java.lang.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
-
getWorkflowId
public java.lang.String getWorkflowId()
Returns the workflow identifier.- Returns:
- the workflow identifier.
- Since:
- 7.0.0
-
setWorkflow
public void setWorkflow(ServiceInstanceWorkflow workflow)
Sets the workflow identifier.- Parameters:
workflow
- the workflow identifier.- Since:
- 7.0.0
-
getWorkflowPermissions
public java.util.Set<ServiceInstanceWorkflowPermissionXml> getWorkflowPermissions()
Returns the set of permissions for the XML serialization.- Returns:
- the set of permissions for the XML serialization.
- Since:
- 7.0.0
-
isUsesPublicFileStorage
public boolean isUsesPublicFileStorage()
Returns the usesPublicFileStorage.- Returns:
- the usesPublicFileStorage
- Since:
- 6.2.0
-
getCustomProperties
public java.util.SortedSet<ServiceInstanceCustomProperty> getCustomProperties()
Returns the customProperties.- Returns:
- the customProperties
- Since:
- 6.2.0
-
getFileTransformations
public java.util.Set<FileTransformation> getFileTransformations()
-
getDependencies
public java.util.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(java.lang.String accessControlListId, java.lang.String parentAccessControlListId, java.lang.String propertyBagId, java.lang.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 benull
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 java.lang.String getId()
Description copied from interface:IFileStructureElement
Returns the element's identifier.- Specified by:
getId
in interfaceIFileStructureElement
- Returns:
- the element's identifier.
-
getDirectoryChannelId
public java.lang.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 interfaceIFileStructureElement
- Returns:
- the identifier of the channel.
-
getStructureFileName
public java.lang.String getStructureFileName()
Description copied from interface:IFileStructureElement
Returns the name of the structure file for this element.- Specified by:
getStructureFileName
in interfaceIFileStructureElement
- Returns:
- the structure file name (only the file's name, does not include any path).
-
setChannelId
public void setChannelId(java.lang.String channelId)
-
getChannelId
public java.lang.String getChannelId()
-
setFriendlyId
public void setFriendlyId(java.lang.String friendlyId)
Description copied from interface:IFileStructureElement
Sets the friendly identifier for this structure element.- Specified by:
setFriendlyId
in interfaceIFileStructureElement
- Parameters:
friendlyId
- the friendly identifier.
-
getPropertyBag
public PropertyBag getPropertyBag()
-
clone
protected java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
-
adjustChannelTemplateLink
public void adjustChannelTemplateLink(java.util.Queue<ParallelExecutor.IDatabaseTask> channelTemplateLinksToAdd)
- Parameters:
channelTemplateLinksToAdd
-- Since:
- 6.2.0
-
isEquivalent
public boolean isEquivalent(java.lang.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 interfaceICustomEquivalence
- Parameters:
obj
- the object to compare with.- Returns:
- true if the objects are equivalent, false otherwise.
-
-